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 "simgrid/Exception.hpp"
   8 #include "smx_private.hpp"
   9 #include "src/kernel/activity/CommImpl.hpp"
  10 #include "src/kernel/activity/ExecImpl.hpp"
  11 #include "src/kernel/activity/IoImpl.hpp"
  12 #include "src/kernel/activity/SleepImpl.hpp"
  13 #include "src/kernel/activity/SynchroRaw.hpp"
  14 #include "src/mc/mc_replay.hpp"
  15 #include "src/mc/remote/Client.hpp"
  16 #include "src/simix/smx_host_private.hpp"
  17 #include "src/simix/smx_io_private.hpp"
  18 #include "src/simix/smx_synchro_private.hpp"
  19 #include "src/surf/HostImpl.hpp"
  20 #include "src/surf/cpu_interface.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   simix_global->mutex.lock();
  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 = false;
 115
 116   simix_global->mutex.unlock();
 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_ = true;
 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_ = false;
 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     throw new simgrid::HostFailureException(XBT_THROW_POINT,
 233         std::string("Host ") + std::string(host_->get_cname())+" failed, you cannot sleep there.");
 234
 235   simgrid::kernel::activity::SleepImpl* synchro = new simgrid::kernel::activity::SleepImpl();
 236   synchro->host                                 = host_;
 237   synchro->surf_sleep                           = host_->pimpl_cpu->sleep(duration);
 238   synchro->surf_sleep->set_data(synchro);
 239   XBT_DEBUG("Create sleep synchronization %p", synchro);
 240
 241   return synchro;
 242 }
 243
 244 void ActorImpl::throw_exception(std::exception_ptr e)
 245 {
 246   exception = e;
 247
 248   if (suspended_)
 249     resume();
 250
 251   /* cancel the blocking synchro if any */
 252   if (waiting_synchro) {
 253
 254     simgrid::kernel::activity::ExecImplPtr exec =
 255         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(waiting_synchro);
 256     if (exec != nullptr && exec->surf_action_)
 257       exec->surf_action_->cancel();
 258
 259     simgrid::kernel::activity::CommImplPtr comm =
 260         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(waiting_synchro);
 261     if (comm != nullptr) {
 262       comms.remove(comm);
 263       comm->cancel();
 264     }
 265
 266     simgrid::kernel::activity::SleepImplPtr sleep =
 267         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(waiting_synchro);
 268     if (sleep != nullptr) {
 269       SIMIX_process_sleep_destroy(waiting_synchro);
 270       if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), this) ==
 271               end(simix_global->process_to_run) &&
 272           this != SIMIX_process_self()) {
 273         XBT_DEBUG("Inserting %s in the to_run list", get_cname());
 274         simix_global->process_to_run.push_back(this);
 275       }
 276     }
 277
 278     simgrid::kernel::activity::RawImplPtr raw =
 279         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(waiting_synchro);
 280     if (raw != nullptr) {
 281       SIMIX_synchro_stop_waiting(this, &simcall);
 282     }
 283
 284     simgrid::kernel::activity::IoImplPtr io =
 285         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(waiting_synchro);
 286     if (io != nullptr) {
 287       delete io.get();
 288     }
 289   }
 290   waiting_synchro = nullptr;
 291 }
 292
 293 void create_maestro(simgrid::simix::ActorCode code)
 294 {
 295   smx_actor_t maestro = nullptr;
 296   /* Create maestro process and initialize it */
 297   maestro           = new simgrid::kernel::actor::ActorImpl();
 298   maestro->pid_     = simix_process_maxpid++;
 299   maestro->name_    = "";
 300   maestro->set_user_data(nullptr);
 301
 302   if (not code) {
 303     maestro->context_ = SIMIX_context_new(simgrid::simix::ActorCode(), nullptr, maestro);
 304   } else {
 305     if (not simix_global)
 306       xbt_die("simix is not initialized, please call MSG_init first");
 307     maestro->context_ = simix_global->context_factory->create_maestro(code, maestro);
 308   }
 309
 310   maestro->simcall.issuer = maestro;
 311   simix_global->maestro_process = maestro;
 312 }
 313
 314 } // namespace actor
 315 }
 316 }
 317
 318 /** @brief Creates and runs the maestro process */
 319 void SIMIX_maestro_create(void (*code)(void*), void* data)
 320 {
 321   simgrid::kernel::actor::create_maestro(std::bind(code, data));
 322 }
 323
 324 /**
 325  * @brief Internal function to create a process.
 326  *
 327  * This function actually creates the process.
 328  * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
 329  * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
 330  *
 331  * @return the process created
 332  */
 333 smx_actor_t SIMIX_process_create(std::string name, simgrid::simix::ActorCode code, void* data, simgrid::s4u::Host* host,
 334                                  std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
 335 {
 336
 337   XBT_DEBUG("Start process %s on host '%s'", name.c_str(), host->get_cname());
 338
 339   if (host->is_off()) {
 340     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
 341     return nullptr;
 342   }
 343
 344   smx_actor_t process = new simgrid::kernel::actor::ActorImpl();
 345
 346   xbt_assert(code && host != nullptr, "Invalid parameters");
 347   /* Process data */
 348   process->pid_           = simix_process_maxpid++;
 349   process->name_          = simgrid::xbt::string(name);
 350   process->host_          = host;
 351   process->set_user_data(data);
 352   process->simcall.issuer = process;
 353
 354   if (parent_process != nullptr) {
 355     process->ppid_ = parent_process->pid_;
 356   }
 357
 358   process->code         = code;
 359
 360   XBT_VERB("Create context %s", process->get_cname());
 361   process->context_ = SIMIX_context_new(std::move(code), simix_global->cleanup_process_function, process);
 362
 363   /* Add properties */
 364   if (properties != nullptr)
 365     for (auto const& kv : *properties)
 366       process->set_property(kv.first, kv.second);
 367
 368   /* Add the process to its host's process list */
 369   host->pimpl_->process_list_.push_back(*process);
 370
 371   XBT_DEBUG("Start context '%s'", process->get_cname());
 372
 373   /* Now insert it in the global process list and in the process to run list */
 374   simix_global->process_list[process->pid_] = process;
 375   XBT_DEBUG("Inserting %s(%s) in the to_run list", process->get_cname(), host->get_cname());
 376   simix_global->process_to_run.push_back(process);
 377   intrusive_ptr_add_ref(process);
 378
 379   /* The onCreation() signal must be delayed until there, where the pid and everything is set */
 380   simgrid::s4u::ActorPtr tmp = process->iface(); // Passing this directly to onCreation will lead to crashes
 381   simgrid::s4u::Actor::on_creation(tmp);
 382
 383   return process;
 384 }
 385
 386 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
 387                                  std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
 388 {
 389   // This is mostly a copy/paste from SIMIX_process_new(),
 390   // it'd be nice to share some code between those two functions.
 391
 392   sg_host_t host = sg_host_by_name(hostname);
 393   XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
 394
 395   if (host->is_off()) {
 396     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, hostname);
 397     return nullptr;
 398   }
 399
 400   smx_actor_t process = new simgrid::kernel::actor::ActorImpl();
 401   /* Process data */
 402   process->pid_  = simix_process_maxpid++;
 403   process->name_ = std::string(name);
 404   process->host_ = host;
 405   process->set_user_data(data);
 406   process->simcall.issuer = process;
 407
 408   if (parent_process != nullptr) {
 409     process->ppid_ = parent_process->pid_;
 410   }
 411
 412   /* Process data for auto-restart */
 413   process->code = nullptr;
 414
 415   XBT_VERB("Create context %s", process->get_cname());
 416   if (not simix_global)
 417     xbt_die("simix is not initialized, please call MSG_init first");
 418   process->context_ = simix_global->context_factory->attach(simix_global->cleanup_process_function, process);
 419
 420   /* Add properties */
 421   if (properties != nullptr)
 422     for (auto const& kv : *properties)
 423       process->set_property(kv.first, kv.second);
 424
 425   /* Add the process to it's host process list */
 426   host->pimpl_->process_list_.push_back(*process);
 427
 428   /* Now insert it in the global process list and in the process to run list */
 429   simix_global->process_list[process->pid_] = process;
 430   XBT_DEBUG("Inserting %s(%s) in the to_run list", process->get_cname(), host->get_cname());
 431   simix_global->process_to_run.push_back(process);
 432   intrusive_ptr_add_ref(process);
 433
 434   auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(process->context_);
 435   if (not context)
 436     xbt_die("Not a suitable context");
 437
 438   context->attach_start();
 439
 440   /* The onCreation() signal must be delayed until there, where the pid and everything is set */
 441   simgrid::s4u::ActorPtr tmp = process->iface(); // Passing this directly to onCreation will lead to crashes
 442   simgrid::s4u::Actor::on_creation(tmp);
 443
 444   return process;
 445 }
 446
 447 void SIMIX_process_detach()
 448 {
 449   auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(SIMIX_context_self());
 450   if (not context)
 451     xbt_die("Not a suitable context");
 452
 453   auto process = context->process();
 454   simix_global->cleanup_process_function(process);
 455   context->attach_stop();
 456 }
 457
 458 /**
 459  * @brief Executes the processes from simix_global->process_to_run.
 460  *
 461  * The processes of simix_global->process_to_run are run (in parallel if
 462  * possible).  On exit, simix_global->process_to_run is empty, and
 463  * simix_global->process_that_ran contains the list of processes that just ran.
 464  * The two lists are swapped so, be careful when using them before and after a
 465  * call to this function.
 466  */
 467 void SIMIX_process_runall()
 468 {
 469   SIMIX_context_runall();
 470
 471   simix_global->process_to_run.swap(simix_global->process_that_ran);
 472   simix_global->process_to_run.clear();
 473 }
 474
 475 /**
 476  * @brief Internal function to kill a SIMIX process.
 477  *
 478  * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
 479  * or directly for SIMIX internal purposes.
 480  *
 481  * @param process poor victim
 482  * @param issuer the process which has sent the PROCESS_KILL. Important to not schedule twice the same process.
 483  */
 484 void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
 485
 486   if (process->finished_) {
 487     XBT_DEBUG("Ignoring request to kill process %s@%s that is already dead", process->get_cname(),
 488               process->host_->get_cname());
 489     return;
 490   }
 491
 492   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", issuer->get_cname(),
 493             (issuer->host_ == nullptr ? "(null)" : issuer->host_->get_cname()), process->get_cname(),
 494             process->host_->get_cname());
 495
 496   process->context_->iwannadie = true;
 497   process->blocked_            = false;
 498   process->suspended_          = false;
 499   process->exception = nullptr;
 500
 501   /* destroy the blocking synchro if any */
 502   if (process->waiting_synchro != nullptr) {
 503     if (process->host_->is_off())
 504       process->exception = std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Host failed"));
 505     simgrid::kernel::activity::ExecImplPtr exec =
 506         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro);
 507     simgrid::kernel::activity::CommImplPtr comm =
 508         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
 509     simgrid::kernel::activity::SleepImplPtr sleep =
 510         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro);
 511     simgrid::kernel::activity::RawImplPtr raw =
 512         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro);
 513     simgrid::kernel::activity::IoImplPtr io =
 514         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro);
 515
 516     if (exec != nullptr) {
 517       if (exec->surf_action_) {
 518         exec->surf_action_->cancel();
 519         exec->surf_action_->unref();
 520         exec->surf_action_ = nullptr;
 521       }
 522     } else if (comm != nullptr) {
 523       process->comms.remove(process->waiting_synchro);
 524       comm->cancel();
 525       // Remove first occurrence of &process->simcall:
 526       auto i = boost::range::find(process->waiting_synchro->simcalls_, &process->simcall);
 527       if (i != process->waiting_synchro->simcalls_.end())
 528         process->waiting_synchro->simcalls_.remove(&process->simcall);
 529     } else if (sleep != nullptr) {
 530       if (sleep->surf_sleep)
 531         sleep->surf_sleep->cancel();
 532       sleep->post();
 533     } else if (raw != nullptr) {
 534       SIMIX_synchro_stop_waiting(process, &process->simcall);
 535
 536     } else if (io != nullptr) {
 537       delete io.get();
 538     } else {
 539       xbt_die("Unknown type of activity");
 540     }
 541
 542     process->waiting_synchro = nullptr;
 543   }
 544   if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), process) ==
 545           end(simix_global->process_to_run) &&
 546       process != issuer) {
 547     XBT_DEBUG("Inserting %s in the to_run list", process->get_cname());
 548     simix_global->process_to_run.push_back(process);
 549   }
 550 }
 551
 552 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
 553  * transition */
 554 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg) {
 555   SMX_EXCEPTION(process, cat, value, msg);
 556
 557   if (process->suspended_)
 558     process->resume();
 559
 560   /* cancel the blocking synchro if any */
 561   if (process->waiting_synchro) {
 562
 563     simgrid::kernel::activity::ExecImplPtr exec =
 564         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro);
 565     if (exec != nullptr && exec->surf_action_)
 566       exec->surf_action_->cancel();
 567
 568     simgrid::kernel::activity::CommImplPtr comm =
 569         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
 570     if (comm != nullptr) {
 571       process->comms.remove(comm);
 572       comm->cancel();
 573     }
 574
 575     simgrid::kernel::activity::SleepImplPtr sleep =
 576         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro);
 577     if (sleep != nullptr) {
 578       SIMIX_process_sleep_destroy(process->waiting_synchro);
 579       if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), process) ==
 580               end(simix_global->process_to_run) &&
 581           process != SIMIX_process_self()) {
 582         XBT_DEBUG("Inserting %s in the to_run list", process->get_cname());
 583         simix_global->process_to_run.push_back(process);
 584       }
 585     }
 586
 587     simgrid::kernel::activity::RawImplPtr raw =
 588         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro);
 589     if (raw != nullptr) {
 590       SIMIX_synchro_stop_waiting(process, &process->simcall);
 591     }
 592
 593     simgrid::kernel::activity::IoImplPtr io =
 594         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro);
 595     if (io != nullptr) {
 596       delete io.get();
 597     }
 598   }
 599   process->waiting_synchro = nullptr;
 600
 601 }
 602
 603 /**
 604  * @brief Kills all running processes.
 605  * @param issuer this one will not be killed
 606  */
 607 void SIMIX_process_killall(smx_actor_t issuer)
 608 {
 609   for (auto const& kv : simix_global->process_list)
 610     if (kv.second != issuer)
 611       SIMIX_process_kill(kv.second, issuer);
 612 }
 613
 614 void SIMIX_process_change_host(smx_actor_t actor, sg_host_t dest)
 615 {
 616   xbt_assert((actor != nullptr), "Invalid parameters");
 617   simgrid::xbt::intrusive_erase(actor->host_->pimpl_->process_list_, *actor);
 618   actor->host_ = dest;
 619   dest->pimpl_->process_list_.push_back(*actor);
 620 }
 621
 622 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t process)
 623 {
 624   smx_activity_t sync_suspend = process->suspend(simcall->issuer);
 625
 626   if (process != simcall->issuer) {
 627     SIMIX_simcall_answer(simcall);
 628   } else {
 629     sync_suspend->simcalls_.push_back(simcall);
 630     process->waiting_synchro = sync_suspend;
 631     process->waiting_synchro->suspend();
 632   }
 633   /* If we are suspending ourselves, then just do not finish the simcall now */
 634 }
 635
 636 int SIMIX_process_get_maxpid() {
 637   return simix_process_maxpid;
 638 }
 639
 640 int SIMIX_process_count()
 641 {
 642   return simix_global->process_list.size();
 643 }
 644
 645 void* SIMIX_process_self_get_data()
 646 {
 647   smx_actor_t self = SIMIX_process_self();
 648
 649   if (not self) {
 650     return nullptr;
 651   }
 652   return self->get_user_data();
 653 }
 654
 655 void SIMIX_process_self_set_data(void *data)
 656 {
 657   SIMIX_process_self()->set_user_data(data);
 658 }
 659
 660
 661 /* needs to be public and without simcall because it is called
 662    by exceptions and logging events */
 663 const char* SIMIX_process_self_get_name() {
 664
 665   smx_actor_t process = SIMIX_process_self();
 666   if (process == nullptr || process == simix_global->maestro_process)
 667     return "maestro";
 668
 669   return process->get_cname();
 670 }
 671
 672 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
 673 {
 674   if (process->finished_) {
 675     // The joined process is already finished, just wake up the issuer process right away
 676     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 677     SIMIX_simcall_answer(simcall);
 678     return;
 679   }
 680   smx_activity_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
 681   sync->simcalls_.push_back(simcall);
 682   simcall->issuer->waiting_synchro = sync;
 683 }
 684
 685 smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout)
 686 {
 687   smx_activity_t res = issuer->sleep(timeout);
 688   intrusive_ptr_add_ref(res.get());
 689   SIMIX_process_on_exit(process,
 690                         [](int, void* arg) {
 691                           auto sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(arg);
 692                           if (sleep->surf_sleep)
 693                             sleep->surf_sleep->finish(simgrid::kernel::resource::Action::State::FINISHED);
 694                           intrusive_ptr_release(sleep);
 695                         },
 696                         res.get());
 697   return res;
 698 }
 699
 700 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
 701 {
 702   if (MC_is_active() || MC_record_replay_is_active()) {
 703     MC_process_clock_add(simcall->issuer, duration);
 704     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 705     SIMIX_simcall_answer(simcall);
 706     return;
 707   }
 708   smx_activity_t sync = simcall->issuer->sleep(duration);
 709   sync->simcalls_.push_back(simcall);
 710   simcall->issuer->waiting_synchro = sync;
 711 }
 712
 713 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
 714 {
 715   XBT_DEBUG("Destroy sleep synchro %p", synchro.get());
 716   simgrid::kernel::activity::SleepImplPtr sleep =
 717       boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(synchro);
 718
 719   if (sleep->surf_sleep) {
 720     sleep->surf_sleep->unref();
 721     sleep->surf_sleep = nullptr;
 722   }
 723 }
 724
 725 /**
 726  * @brief Calling this function makes the process to yield.
 727  *
 728  * Only the current process can call this function, giving back the control to maestro.
 729  *
 730  * @param self the current process
 731  */
 732 void SIMIX_process_yield(smx_actor_t self)
 733 {
 734   XBT_DEBUG("Yield actor '%s'", self->get_cname());
 735
 736   /* Go into sleep and return control to maestro */
 737   self->context_->suspend();
 738
 739   /* Ok, maestro returned control to us */
 740   XBT_DEBUG("Control returned to me: '%s'", self->get_cname());
 741
 742   if (self->context_->iwannadie) {
 743     XBT_DEBUG("I wanna die!");
 744     self->finished_ = true;
 745     /* execute the on_exit functions */
 746     SIMIX_process_on_exit_runall(self);
 747
 748     if (self->auto_restart_ && self->host_->is_off() &&
 749         watched_hosts.find(self->host_->get_cname()) == watched_hosts.end()) {
 750       XBT_DEBUG("Push host %s to watched_hosts because it's off and %s needs to restart", self->host_->get_cname(),
 751                 self->get_cname());
 752       watched_hosts.insert(self->host_->get_cname());
 753     }
 754
 755     XBT_DEBUG("Process %s@%s is dead", self->get_cname(), self->host_->get_cname());
 756     self->context_->stop();
 757   }
 758
 759   if (self->suspended_) {
 760     XBT_DEBUG("Hey! I'm suspended.");
 761     xbt_assert(self->exception != nullptr, "Gasp! This exception may be lost by subsequent calls.");
 762     self->suspended_ = false;
 763     self->suspend(self);
 764   }
 765
 766   if (self->exception != nullptr) {
 767     XBT_DEBUG("Wait, maestro left me an exception");
 768     std::exception_ptr exception = std::move(self->exception);
 769     self->exception = nullptr;
 770     std::rethrow_exception(std::move(exception));
 771   }
 772
 773   if (SMPI_switch_data_segment && not self->finished_) {
 774     SMPI_switch_data_segment(self->iface());
 775   }
 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   simgrid::s4u::Actor::on_destruction(process->iface());
 793   smx_process_exit_status_t exit_status = (process->context_->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
 794   while (not process->on_exit.empty()) {
 795     s_smx_process_exit_fun_t exit_fun = process->on_exit.back();
 796     process->on_exit.pop_back();
 797     (exit_fun.fun)(exit_status, exit_fun.arg);
 798   }
 799 }
 800
 801 void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data)
 802 {
 803   SIMIX_process_on_exit(process, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 804 }
 805
 806 void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data)
 807 {
 808   xbt_assert(process, "current process not found: are you in maestro context ?");
 809
 810   process->on_exit.emplace_back(s_smx_process_exit_fun_t{fun, data});
 811 }
 812
 813 /** @brief Restart a process, starting it again from the beginning. */
 814 /**
 815  * @ingroup simix_process_management
 816  * @brief Creates and runs a new SIMIX process.
 817  *
 818  * The structure and the corresponding thread are created and put in the list of ready processes.
 819  *
 820  * @param name a name for the process. It is for user-level information and can be nullptr.
 821  * @param code the main function of the process
 822  * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
 823  * be nullptr.
 824  * It can be retrieved with the method ActorImpl::getUserData().
 825  * @param host where the new agent is executed.
 826  * @param argc first argument passed to @a code
 827  * @param argv second argument passed to @a code
 828  * @param properties the properties of the process
 829  */
 830 smx_actor_t simcall_process_create(std::string name, xbt_main_func_t code, void* data, sg_host_t host, int argc,
 831                                    char** argv, std::unordered_map<std::string, std::string>* properties)
 832 {
 833   auto wrapped_code = simgrid::xbt::wrap_main(code, argc, argv);
 834   for (int i = 0; i != argc; ++i)
 835     xbt_free(argv[i]);
 836   xbt_free(argv);
 837   smx_actor_t res = simcall_process_create(name, std::move(wrapped_code), data, host, properties);
 838   return res;
 839 }
 840
 841 smx_actor_t simcall_process_create(std::string name, simgrid::simix::ActorCode code, void* data, sg_host_t host,
 842                                    std::unordered_map<std::string, std::string>* properties)
 843 {
 844   smx_actor_t self = SIMIX_process_self();
 845   return simgrid::simix::simcall([name, code, data, host, properties, self] {
 846     return SIMIX_process_create(name, std::move(code), data, host, properties, self);
 847   });
 848 }