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