1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved. */
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. */
11 #include <boost/range/algorithm.hpp>
15 #include "xbt/functional.hpp"
17 #include "xbt/sysdep.h"
19 #include "simgrid/s4u/Host.hpp"
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"
34 #include "src/smpi/private.h"
37 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
39 unsigned long simix_process_maxpid = 0;
41 /** Increase the refcount for this process */
42 smx_actor_t SIMIX_process_ref(smx_actor_t process)
44 if (process != nullptr)
45 intrusive_ptr_add_ref(process);
49 /** Decrease the refcount for this process */
50 void SIMIX_process_unref(smx_actor_t process)
52 if (process != nullptr)
53 intrusive_ptr_release(process);
57 * \brief Returns the current agent.
59 * This functions returns the currently running SIMIX process.
61 * \return The SIMIX process
63 smx_actor_t SIMIX_process_self()
65 smx_context_t self_context = SIMIX_context_self();
67 return (self_context != nullptr) ? self_context->process() : nullptr;
71 * \brief Returns whether a process has pending asynchronous communications.
72 * \return true if there are asynchronous communications in this process
74 int SIMIX_process_has_pending_comms(smx_actor_t process) {
76 return process->comms.size() > 0;
80 * \brief Moves a process to the list of processes to destroy.
82 void SIMIX_process_cleanup(smx_actor_t process)
84 XBT_DEBUG("Cleanup process %s (%p), waiting synchro %p",
85 process->name.c_str(), process, process->waiting_synchro);
87 process->finished = true;
88 SIMIX_process_on_exit_runall(process);
90 /* Unregister from the kill timer if any */
91 if (process->kill_timer != nullptr)
92 SIMIX_timer_remove(process->kill_timer);
94 xbt_os_mutex_acquire(simix_global->mutex);
96 /* cancel non-blocking communications */
97 smx_activity_t synchro = static_cast<smx_activity_t>(process->comms.front());
98 while (not process->comms.empty()) {
99 simgrid::kernel::activity::CommImpl* comm = static_cast<simgrid::kernel::activity::CommImpl*>(synchro);
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 */
105 if (comm->src_proc == process) {
106 XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p",
107 comm, comm->detached, (int)comm->state, comm->src_proc, comm->dst_proc);
108 comm->src_proc = nullptr;
110 /* I'm not supposed to destroy a detached comm from the sender side, */
112 XBT_DEBUG("Don't destroy it since it's a detached comm and I'm the sender");
114 SIMIX_comm_unref(comm);
115 } else if (comm->dst_proc == process) {
116 XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p",
117 comm, (int)comm->state, comm->src_proc, comm->dst_proc);
118 comm->dst_proc = nullptr;
120 if (comm->detached && comm->src_proc != nullptr) {
121 /* the comm will be freed right now, remove it from the sender */
122 comm->src_proc->comms.remove(comm);
124 // SIMIX_comm_unref(comm);
126 xbt_die("Communication synchro %p is in my list but I'm not the sender nor the receiver", synchro);
128 process->comms.pop_front();
129 synchro = static_cast<smx_activity_t>(process->comms.front());
132 XBT_DEBUG("%p should not be run anymore",process);
133 simix_global->process_list.erase(process->pid);
135 xbt_swag_remove(process, process->host->extension<simgrid::simix::Host>()->process_list);
136 xbt_swag_insert(process, simix_global->process_to_destroy);
137 process->context->iwannadie = 0;
139 xbt_os_mutex_release(simix_global->mutex);
145 * Should be called some time to time to free the memory allocated for processes that have finished (or killed).
147 void SIMIX_process_empty_trash()
149 smx_actor_t process = static_cast<smx_actor_t>(xbt_swag_extract(simix_global->process_to_destroy));
152 XBT_DEBUG("Getting rid of %p",process);
153 intrusive_ptr_release(process);
154 process = static_cast<smx_actor_t>(xbt_swag_extract(simix_global->process_to_destroy));
161 ActorImpl::~ActorImpl()
163 delete this->context;
164 xbt_dict_free(&this->properties);
167 static int dying_daemon(void* exit_status, void* data)
169 std::vector<ActorImpl*>* vect = &simix_global->daemons;
171 auto it = std::find(vect->begin(), vect->end(), static_cast<ActorImpl*>(data));
172 xbt_assert(it != vect->end(), "The dying daemon is not a daemon after all. Please report that bug.");
174 /* Don't move the whole content since we don't really care about the order */
175 std::swap(*it, vect->back());
180 /** This process will be terminated automatically when the last non-daemon process finishes */
181 void ActorImpl::daemonize()
185 simix_global->daemons.push_back(this);
186 SIMIX_process_on_exit(this, dying_daemon, this);
190 /** Whether this process is daemonized */
191 bool ActorImpl::isDaemon()
196 void create_maestro(std::function<void()> code)
198 smx_actor_t maestro = nullptr;
199 /* Create maestro process and initialize it */
200 maestro = new simgrid::simix::ActorImpl();
201 maestro->pid = simix_process_maxpid++;
203 maestro->data = nullptr;
206 maestro->context = SIMIX_context_new(std::function<void()>(), nullptr, maestro);
208 if (not simix_global)
209 xbt_die("simix is not initialized, please call MSG_init first");
211 simix_global->context_factory->create_maestro(code, maestro);
214 maestro->simcall.issuer = maestro;
215 simix_global->maestro_process = maestro;
221 /** @brief Creates and runs the maestro process */
222 void SIMIX_maestro_create(void (*code)(void*), void* data)
224 simgrid::simix::create_maestro(std::bind(code, data));
228 * \brief Internal function to create a process.
230 * This function actually creates the process.
231 * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
232 * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
234 * \return the process created
236 smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, void* data, simgrid::s4u::Host* host,
237 xbt_dict_t properties, smx_actor_t parent_process)
240 XBT_DEBUG("Start process %s on host '%s'", name, host->cname());
243 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, host->cname());
247 smx_actor_t process = new simgrid::simix::ActorImpl();
249 xbt_assert(code && host != nullptr, "Invalid parameters");
251 process->pid = simix_process_maxpid++;
252 process->name = simgrid::xbt::string(name);
253 process->host = host;
254 process->data = data;
255 process->simcall.issuer = process;
257 if (parent_process != nullptr) {
258 process->ppid = parent_process->pid;
259 /* SMPI process have their own data segment and each other inherit from their father */
261 if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP) {
262 if (parent_process->pid != 0) {
263 SIMIX_segment_index_set(process, parent_process->segment_index);
265 SIMIX_segment_index_set(process, process->pid - 1);
271 process->code = code;
273 XBT_VERB("Create context %s", process->name.c_str());
274 process->context = SIMIX_context_new(std::move(code), simix_global->cleanup_process_function, process);
277 process->properties = properties;
279 /* Make sure that the process is initialized for simix, in case we are called from the Host::onCreation signal */
280 if (host->extension<simgrid::simix::Host>() == nullptr)
281 host->extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
283 /* Add the process to it's host process list */
284 xbt_swag_insert(process, host->extension<simgrid::simix::Host>()->process_list);
286 XBT_DEBUG("Start context '%s'", process->name.c_str());
288 /* Now insert it in the global process list and in the process to run list */
289 simix_global->process_list[process->pid] = process;
290 XBT_DEBUG("Inserting %s(%s) in the to_run list", process->cname(), host->cname());
291 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
293 /* Tracing the process creation */
294 TRACE_msg_process_create(process->cname(), process->pid, process->host);
299 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname, xbt_dict_t properties,
300 smx_actor_t parent_process)
302 // This is mostly a copy/paste from SIMIX_process_new(),
303 // it'd be nice to share some code between those two functions.
305 sg_host_t host = sg_host_by_name(hostname);
306 XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
309 XBT_WARN("Cannot launch process '%s' on failed host '%s'",
314 smx_actor_t process = new simgrid::simix::ActorImpl();
316 process->pid = simix_process_maxpid++;
317 process->name = std::string(name);
318 process->host = host;
319 process->data = data;
320 process->simcall.issuer = process;
322 if (parent_process != nullptr) {
323 process->ppid = parent_process->pid;
324 /* SMPI process have their own data segment and each other inherit from their father */
326 if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP) {
327 if (parent_process->pid != 0) {
328 SIMIX_segment_index_set(process, parent_process->segment_index);
330 SIMIX_segment_index_set(process, process->pid - 1);
336 /* Process data for auto-restart */
337 process->code = nullptr;
339 XBT_VERB("Create context %s", process->name.c_str());
340 if (not simix_global)
341 xbt_die("simix is not initialized, please call MSG_init first");
342 process->context = simix_global->context_factory->attach(
343 simix_global->cleanup_process_function, process);
346 process->properties = properties;
348 /* Add the process to it's host process list */
349 xbt_swag_insert(process, host->extension<simgrid::simix::Host>()->process_list);
351 /* Now insert it in the global process list and in the process to run list */
352 simix_global->process_list[process->pid] = process;
353 XBT_DEBUG("Inserting %s(%s) in the to_run list", process->cname(), host->cname());
354 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
356 /* Tracing the process creation */
357 TRACE_msg_process_create(process->cname(), process->pid, process->host);
359 auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(process->context);
361 xbt_die("Not a suitable context");
363 context->attach_start();
367 void SIMIX_process_detach()
369 auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(SIMIX_context_self());
371 xbt_die("Not a suitable context");
373 simix_global->cleanup_process_function(context->process());
375 // Let maestro ignore we are still alive:
376 // xbt_swag_remove(context->process(), simix_global->process_list);
378 // TODO, Remove from proces list:
379 // xbt_swag_remove(process, sg_host_simix(host)->process_list);
381 context->attach_stop();
386 * \brief Executes the processes from simix_global->process_to_run.
388 * The processes of simix_global->process_to_run are run (in parallel if
389 * possible). On exit, simix_global->process_to_run is empty, and
390 * simix_global->process_that_ran contains the list of processes that just ran.
391 * The two lists are swapped so, be careful when using them before and after a
392 * call to this function.
394 void SIMIX_process_runall()
396 SIMIX_context_runall();
398 xbt_dynar_t tmp = simix_global->process_that_ran;
399 simix_global->process_that_ran = simix_global->process_to_run;
400 simix_global->process_to_run = tmp;
401 xbt_dynar_reset(simix_global->process_to_run);
404 void simcall_HANDLER_process_kill(smx_simcall_t simcall, smx_actor_t process) {
405 SIMIX_process_kill(process, simcall->issuer);
408 * \brief Internal function to kill a SIMIX process.
410 * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
411 * or directly for SIMIX internal purposes.
413 * \param process poor victim
414 * \param issuer the process which has sent the PROCESS_KILL. Important to not schedule twice the same process.
416 void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
418 XBT_DEBUG("Killing process %s@%s", process->cname(), process->host->cname());
420 process->context->iwannadie = 1;
421 process->blocked = 0;
422 process->suspended = 0;
423 process->exception = nullptr;
425 /* destroy the blocking synchro if any */
426 if (process->waiting_synchro) {
428 simgrid::kernel::activity::ExecImpl* exec =
429 dynamic_cast<simgrid::kernel::activity::ExecImpl*>(process->waiting_synchro);
430 simgrid::kernel::activity::CommImpl* comm =
431 dynamic_cast<simgrid::kernel::activity::CommImpl*>(process->waiting_synchro);
432 simgrid::kernel::activity::SleepImpl* sleep =
433 dynamic_cast<simgrid::kernel::activity::SleepImpl*>(process->waiting_synchro);
434 simgrid::kernel::activity::Raw *raw = dynamic_cast<simgrid::kernel::activity::Raw*>(process->waiting_synchro);
435 simgrid::kernel::activity::Io *io = dynamic_cast<simgrid::kernel::activity::Io*>(process->waiting_synchro);
437 if (exec != nullptr) {
440 } else if (comm != nullptr) {
441 process->comms.remove(process->waiting_synchro);
443 // Remove first occurrence of &process->simcall:
444 auto i = boost::range::find(process->waiting_synchro->simcalls, &process->simcall);
445 if (i != process->waiting_synchro->simcalls.end())
446 process->waiting_synchro->simcalls.remove(&process->simcall);
447 SIMIX_comm_unref(comm);
448 } else if (sleep != nullptr) {
449 SIMIX_process_sleep_destroy(process->waiting_synchro);
451 } else if (raw != nullptr) {
452 SIMIX_synchro_stop_waiting(process, &process->simcall);
453 delete process->waiting_synchro;
455 } else if (io != nullptr) {
456 SIMIX_io_destroy(process->waiting_synchro);
460 switch (process->waiting_synchro->type) {
461 case SIMIX_SYNC_JOIN:
462 SIMIX_process_sleep_destroy(process->waiting_synchro);
466 process->waiting_synchro = nullptr;
468 if (not xbt_dynar_member(simix_global->process_to_run, &(process)) && process != issuer) {
469 XBT_DEBUG("Inserting %s in the to_run list", process->name.c_str());
470 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
474 /** @brief Ask another process to raise the given exception
476 * @param process The process that should raise that exception
477 * @param cat category of exception
478 * @param value value associated to the exception
479 * @param msg string information associated to the exception
481 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg) {
482 SMX_EXCEPTION(process, cat, value, msg);
484 if (process->suspended)
485 SIMIX_process_resume(process);
487 /* cancel the blocking synchro if any */
488 if (process->waiting_synchro) {
490 simgrid::kernel::activity::ExecImpl* exec =
491 dynamic_cast<simgrid::kernel::activity::ExecImpl*>(process->waiting_synchro);
492 if (exec != nullptr) {
493 SIMIX_execution_cancel(process->waiting_synchro);
496 simgrid::kernel::activity::CommImpl* comm =
497 dynamic_cast<simgrid::kernel::activity::CommImpl*>(process->waiting_synchro);
498 if (comm != nullptr) {
499 process->comms.remove(comm);
503 simgrid::kernel::activity::SleepImpl* sleep =
504 dynamic_cast<simgrid::kernel::activity::SleepImpl*>(process->waiting_synchro);
505 if (sleep != nullptr) {
506 SIMIX_process_sleep_destroy(process->waiting_synchro);
507 if (not xbt_dynar_member(simix_global->process_to_run, &(process)) && process != SIMIX_process_self()) {
508 XBT_DEBUG("Inserting %s in the to_run list", process->name.c_str());
509 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
513 simgrid::kernel::activity::Raw *raw = dynamic_cast<simgrid::kernel::activity::Raw*>(process->waiting_synchro);
514 if (raw != nullptr) {
515 SIMIX_synchro_stop_waiting(process, &process->simcall);
518 simgrid::kernel::activity::Io *io = dynamic_cast<simgrid::kernel::activity::Io*>(process->waiting_synchro);
520 SIMIX_io_destroy(process->waiting_synchro);
523 process->waiting_synchro = nullptr;
527 void simcall_HANDLER_process_killall(smx_simcall_t simcall, int reset_pid) {
528 SIMIX_process_killall(simcall->issuer, reset_pid);
531 * \brief Kills all running processes.
532 * \param issuer this one will not be killed
534 void SIMIX_process_killall(smx_actor_t issuer, int reset_pid)
536 for (auto kv : simix_global->process_list)
537 if (kv.second != issuer)
538 SIMIX_process_kill(kv.second, issuer);
541 simix_process_maxpid = reset_pid;
543 SIMIX_context_runall();
545 SIMIX_process_empty_trash();
548 void simcall_HANDLER_process_set_host(smx_simcall_t simcall, smx_actor_t process, sg_host_t dest)
550 process->new_host = dest;
553 void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest)
555 xbt_assert((process != nullptr), "Invalid parameters");
556 xbt_swag_remove(process, process->host->extension<simgrid::simix::Host>()->process_list);
557 process->host = dest;
558 xbt_swag_insert(process, dest->extension<simgrid::simix::Host>()->process_list);
562 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t process)
564 smx_activity_t sync_suspend = SIMIX_process_suspend(process, simcall->issuer);
566 if (process != simcall->issuer) {
567 SIMIX_simcall_answer(simcall);
569 sync_suspend->simcalls.push_back(simcall);
570 process->waiting_synchro = sync_suspend;
571 process->waiting_synchro->suspend();
573 /* If we are suspending ourselves, then just do not finish the simcall now */
576 smx_activity_t SIMIX_process_suspend(smx_actor_t process, smx_actor_t issuer)
578 if (process->suspended) {
579 XBT_DEBUG("Process '%s' is already suspended", process->name.c_str());
583 process->suspended = 1;
585 /* If we are suspending another process that is waiting on a sync, suspend its synchronization. */
586 if (process != issuer) {
588 if (process->waiting_synchro)
589 process->waiting_synchro->suspend();
590 /* If the other process is not waiting, its suspension is delayed to when the process is rescheduled. */
594 return SIMIX_execution_start(process, "suspend", 0.0, 1.0, 0.0);
598 void SIMIX_process_resume(smx_actor_t process)
600 XBT_IN("process = %p", process);
602 if (process->context->iwannadie) {
603 XBT_VERB("Ignoring request to suspend a process that is currently dying.");
607 if (not process->suspended)
609 process->suspended = 0;
611 /* resume the synchronization that was blocking the resumed process. */
612 if (process->waiting_synchro)
613 process->waiting_synchro->resume();
618 int SIMIX_process_get_maxpid() {
619 return simix_process_maxpid;
622 int SIMIX_process_count()
624 return simix_global->process_list.size();
627 int SIMIX_process_get_PID(smx_actor_t self)
635 void* SIMIX_process_self_get_data()
637 smx_actor_t self = SIMIX_process_self();
645 void SIMIX_process_self_set_data(void *data)
647 smx_actor_t self = SIMIX_process_self();
649 SIMIX_process_set_data(self, data);
652 void SIMIX_process_set_data(smx_actor_t process, void *data)
654 process->data = data;
657 /* needs to be public and without simcall because it is called
658 by exceptions and logging events */
659 const char* SIMIX_process_self_get_name() {
661 smx_actor_t process = SIMIX_process_self();
662 if (process == nullptr || process == simix_global->maestro_process)
665 return process->name.c_str();
668 smx_actor_t SIMIX_process_get_by_name(const char* name)
670 for (auto kv : simix_global->process_list)
671 if (kv.second->name == name)
676 int SIMIX_process_is_suspended(smx_actor_t process)
678 return process->suspended;
681 xbt_dict_t SIMIX_process_get_properties(smx_actor_t process)
683 return process->properties;
686 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
688 if (process->finished) {
689 // The joined process is already finished, just wake up the issuer process right away
690 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
691 SIMIX_simcall_answer(simcall);
694 smx_activity_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
695 sync->simcalls.push_back(simcall);
696 simcall->issuer->waiting_synchro = sync;
699 static int SIMIX_process_join_finish(smx_process_exit_status_t status, smx_activity_t synchro){
700 simgrid::kernel::activity::SleepImpl* sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(synchro);
702 if (sleep->surf_sleep) {
703 sleep->surf_sleep->cancel();
705 while (not sleep->simcalls.empty()) {
706 smx_simcall_t simcall = sleep->simcalls.front();
707 sleep->simcalls.pop_front();
708 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
709 simcall->issuer->waiting_synchro = nullptr;
710 if (simcall->issuer->suspended) {
711 XBT_DEBUG("Wait! This process is suspended and can't wake up now.");
712 simcall->issuer->suspended = 0;
713 simcall_HANDLER_process_suspend(simcall, simcall->issuer);
715 SIMIX_simcall_answer(simcall);
718 sleep->surf_sleep->unref();
719 sleep->surf_sleep = nullptr;
722 // intrusive_ptr_release(process); // FIXME: We are leaking here. See comment in SIMIX_process_join()
726 smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout)
728 smx_activity_t res = SIMIX_process_sleep(issuer, timeout);
729 static_cast<simgrid::kernel::activity::ActivityImpl*>(res)->ref();
730 /* We are leaking the process here, but if we don't take the ref, we get a "use after free".
731 * The correct solution would be to derivate the type SynchroSleep into a SynchroProcessJoin,
732 * but the code is not clean enough for now for this.
733 * The C API should first be properly replaced with the C++ one, which is a fair amount of work.
735 intrusive_ptr_add_ref(process);
736 SIMIX_process_on_exit(process, (int_f_pvoid_pvoid_t)SIMIX_process_join_finish, res);
740 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
742 if (MC_is_active() || MC_record_replay_is_active()) {
743 MC_process_clock_add(simcall->issuer, duration);
744 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
745 SIMIX_simcall_answer(simcall);
748 smx_activity_t sync = SIMIX_process_sleep(simcall->issuer, duration);
749 sync->simcalls.push_back(simcall);
750 simcall->issuer->waiting_synchro = sync;
753 smx_activity_t SIMIX_process_sleep(smx_actor_t process, double duration)
755 sg_host_t host = process->host;
758 THROWF(host_error, 0, "Host %s failed, you cannot sleep there.", host->cname());
760 simgrid::kernel::activity::SleepImpl* synchro = new simgrid::kernel::activity::SleepImpl();
761 synchro->host = host;
762 synchro->surf_sleep = host->pimpl_cpu->sleep(duration);
763 synchro->surf_sleep->setData(synchro);
764 XBT_DEBUG("Create sleep synchronization %p", synchro);
769 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
771 XBT_DEBUG("Destroy synchro %p", synchro);
772 simgrid::kernel::activity::SleepImpl* sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(synchro);
774 if (sleep->surf_sleep) {
775 sleep->surf_sleep->unref();
776 sleep->surf_sleep = nullptr;
782 * \brief Calling this function makes the process to yield.
784 * Only the current process can call this function, giving back the control to
787 * \param self the current process
789 void SIMIX_process_yield(smx_actor_t self)
791 XBT_DEBUG("Yield actor '%s'", self->cname());
793 /* Go into sleep and return control to maestro */
794 self->context->suspend();
796 /* Ok, maestro returned control to us */
797 XBT_DEBUG("Control returned to me: '%s'", self->name.c_str());
799 if (self->new_host) {
800 SIMIX_process_change_host(self, self->new_host);
801 self->new_host = nullptr;
804 if (self->context->iwannadie){
805 XBT_DEBUG("I wanna die!");
806 self->finished = true;
807 /* execute the on_exit functions */
808 SIMIX_process_on_exit_runall(self);
809 /* Add the process to the list of process to restart, only if the host is down */
810 if (self->auto_restart && self->host->isOff()) {
811 SIMIX_host_add_auto_restart_process(self->host, self->cname(),
812 self->code, self->data,
813 SIMIX_timer_get_date(self->kill_timer),
817 XBT_DEBUG("Process %s@%s is dead", self->cname(), self->host->cname());
818 self->context->stop();
821 if (self->suspended) {
822 XBT_DEBUG("Hey! I'm suspended.");
823 xbt_assert(self->exception != nullptr, "Gasp! This exception may be lost by subsequent calls.");
825 SIMIX_process_suspend(self, self);
828 if (self->exception != nullptr) {
829 XBT_DEBUG("Wait, maestro left me an exception");
830 std::exception_ptr exception = std::move(self->exception);
831 self->exception = nullptr;
832 std::rethrow_exception(std::move(exception));
835 if(SMPI_switch_data_segment && self->segment_index != -1){
836 SMPI_switch_data_segment(self->segment_index);
840 /* callback: termination */
841 void SIMIX_process_exception_terminate(xbt_ex_t * e)
847 smx_context_t SIMIX_process_get_context(smx_actor_t p) {
851 void SIMIX_process_set_context(smx_actor_t p,smx_context_t c) {
856 * \brief Returns the list of processes to run.
858 xbt_dynar_t SIMIX_process_get_runnable()
860 return simix_global->process_to_run;
864 * \brief Returns the process from PID.
866 smx_actor_t SIMIX_process_from_PID(aid_t PID)
868 if (simix_global->process_list.find(PID) == simix_global->process_list.end())
870 return simix_global->process_list.at(PID);
873 /** @brief returns a dynar containing all currently existing processes */
874 xbt_dynar_t SIMIX_processes_as_dynar() {
875 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t),nullptr);
876 for (auto kv : simix_global->process_list) {
877 smx_actor_t proc = kv.second;
878 xbt_dynar_push(res,&proc);
883 void SIMIX_process_on_exit_runall(smx_actor_t process) {
884 s_smx_process_exit_fun_t exit_fun;
885 smx_process_exit_status_t exit_status = (process->context->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
886 while (not process->on_exit.empty()) {
887 exit_fun = process->on_exit.back();
888 (exit_fun.fun)((void*)exit_status, exit_fun.arg);
889 process->on_exit.pop_back();
893 void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data) {
894 xbt_assert(process, "current process not found: are you in maestro context ?");
896 s_smx_process_exit_fun_t exit_fun = {fun, data};
898 process->on_exit.push_back(exit_fun);
902 * \brief Sets the auto-restart status of the process.
903 * If set to 1, the process will be automatically restarted when its host
906 void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart) {
907 process->auto_restart = auto_restart;
910 smx_actor_t simcall_HANDLER_process_restart(smx_simcall_t simcall, smx_actor_t process) {
911 return SIMIX_process_restart(process, simcall->issuer);
913 /** @brief Restart a process, starting it again from the beginning. */
914 smx_actor_t SIMIX_process_restart(smx_actor_t process, smx_actor_t issuer) {
915 XBT_DEBUG("Restarting process %s on %s", process->cname(), process->host->cname());
917 //retrieve the arguments of the old process
918 //FIXME: Factorize this with SIMIX_host_add_auto_restart_process ?
919 simgrid::simix::ProcessArg arg;
920 arg.name = process->name;
921 arg.code = process->code;
922 arg.host = process->host;
923 arg.kill_time = SIMIX_timer_get_date(process->kill_timer);
924 arg.data = process->data;
925 arg.properties = nullptr;
926 arg.auto_restart = process->auto_restart;
928 //kill the old process
929 SIMIX_process_kill(process, issuer);
931 //start the new process
932 smx_actor_t actor = simix_global->create_process_function(arg.name.c_str(), std::move(arg.code), arg.data, arg.host,
933 arg.properties, nullptr);
934 if (arg.kill_time >= 0)
935 simcall_process_set_kill_time(actor, arg.kill_time);
936 if (arg.auto_restart)
937 simcall_process_auto_restart_set(actor, arg.auto_restart);
942 void SIMIX_segment_index_set(smx_actor_t proc, int index){
943 proc->segment_index = index;
947 * \ingroup simix_process_management
948 * \brief Creates and runs a new SIMIX process.
950 * The structure and the corresponding thread are created and put in the list of ready processes.
952 * \param name a name for the process. It is for user-level information and can be nullptr.
953 * \param code the main function of the process
954 * \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.
955 * It can be retrieved with the function \ref simcall_process_get_data.
956 * \param host where the new agent is executed.
957 * \param kill_time time when the process is killed
958 * \param argc first argument passed to \a code
959 * \param argv second argument passed to \a code
960 * \param properties the properties of the process
961 * \param auto_restart either it is autorestarting or not.
963 smx_actor_t simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc,
964 char** argv, xbt_dict_t properties)
968 auto wrapped_code = simgrid::xbt::wrapMain(code, argc, argv);
969 for (int i = 0; i != argc; ++i)
972 smx_actor_t res = simcall_process_create(name, std::move(wrapped_code), data, host, properties);
976 smx_actor_t simcall_process_create(const char* name, std::function<void()> code, void* data, sg_host_t host,
977 xbt_dict_t properties)
981 smx_actor_t self = SIMIX_process_self();
982 return simgrid::simix::kernelImmediate([name, code, data, host, properties, self] {
983 return SIMIX_process_create(name, std::move(code), data, host, properties, self);