1 /* Copyright (c) 2007-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include <boost/range/algorithm.hpp>
14 #include <xbt/functional.hpp>
16 #include <xbt/sysdep.h>
20 #include <simgrid/s4u/host.hpp>
24 #include "src/surf/surf_interface.hpp"
25 #include "smx_private.h"
26 #include "src/mc/mc_replay.h"
27 #include "src/mc/Client.hpp"
28 #include "src/msg/msg_private.h"
29 #include "src/kernel/activity/SynchroSleep.hpp"
30 #include "src/kernel/activity/SynchroRaw.hpp"
31 #include "src/kernel/activity/SynchroIo.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 xbt_fifo_size(process->comms) > 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>(xbt_fifo_pop(process->comms));
98 while (synchro != nullptr) {
99 simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(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");
117 else if (comm->dst_proc == process){
118 XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p",
119 comm, (int)comm->state, comm->src_proc, comm->dst_proc);
120 comm->dst_proc = nullptr;
122 if (comm->detached && comm->src_proc != nullptr) {
123 /* the comm will be freed right now, remove it from the sender */
124 xbt_fifo_remove(comm->src_proc->comms, comm);
129 xbt_die("Communication synchro %p is in my list but I'm not the sender nor the receiver", synchro);
131 synchro = static_cast<smx_activity_t>(xbt_fifo_pop(process->comms));
134 XBT_DEBUG("%p should not be run anymore",process);
135 xbt_swag_remove(process, simix_global->process_list);
137 xbt_swag_remove(process, sg_host_simix(process->host)->process_list);
138 xbt_swag_insert(process, simix_global->process_to_destroy);
139 process->context->iwannadie = 0;
141 xbt_os_mutex_release(simix_global->mutex);
147 * Should be called some time to time to free the memory allocated for processes
148 * that have finished (or killed).
150 void SIMIX_process_empty_trash()
152 smx_actor_t process = nullptr;
154 while ((process = (smx_actor_t) xbt_swag_extract(simix_global->process_to_destroy))) {
155 XBT_DEBUG("Getting rid of %p",process);
156 intrusive_ptr_release(process);
163 ActorImpl::~ActorImpl()
165 delete this->context;
166 if (this->properties)
167 xbt_dict_free(&this->properties);
168 if (this->comms != nullptr)
169 xbt_fifo_free(this->comms);
171 xbt_dynar_free(&this->on_exit);
174 void create_maestro(std::function<void()> code)
176 smx_actor_t maestro = nullptr;
177 /* Create maestro process and intilialize it */
178 maestro = new simgrid::simix::ActorImpl();
179 maestro->pid = simix_process_maxpid++;
182 maestro->data = nullptr;
185 maestro->context = SIMIX_context_new(std::function<void()>(), nullptr, maestro);
188 xbt_die("simix is not initialized, please call MSG_init first");
190 simix_global->context_factory->create_maestro(code, maestro);
193 maestro->simcall.issuer = maestro;
194 simix_global->maestro_process = maestro;
200 /** @brief Creates and runs the maestro process */
201 void SIMIX_maestro_create(void (*code)(void*), void* data)
203 simgrid::simix::create_maestro(std::bind(code, data));
207 * \brief Stops a process.
209 * Stops the process, execute all the registered on_exit functions,
210 * register it to the list of the process to restart if needed
211 * and stops its context.
213 void SIMIX_process_stop(smx_actor_t arg) {
214 arg->finished = true;
215 /* execute the on_exit functions */
216 SIMIX_process_on_exit_runall(arg);
217 /* Add the process to the list of process to restart, only if the host is down */
218 if (arg->auto_restart && arg->host->isOff()) {
219 SIMIX_host_add_auto_restart_process(arg->host, arg->name.c_str(),
220 arg->code, arg->data,
221 SIMIX_timer_get_date(arg->kill_timer),
225 XBT_DEBUG("Process %s (%s) is dead",
226 arg->name.c_str(), sg_host_get_name(arg->host));
227 arg->context->stop();
231 * \brief Internal function to create a process.
233 * This function actually creates the process.
234 * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
235 * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
237 * \return the process created
239 smx_actor_t SIMIX_process_create(
241 std::function<void()> code,
245 xbt_dict_t properties,
247 smx_actor_t parent_process)
249 smx_actor_t process = nullptr;
251 XBT_DEBUG("Start process %s on host '%s'", name, host->name().c_str());
254 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, host->name().c_str());
258 process = new simgrid::simix::ActorImpl();
260 xbt_assert(code && host != nullptr, "Invalid parameters");
262 process->pid = simix_process_maxpid++;
263 process->name = simgrid::xbt::string(name);
264 process->host = host;
265 process->data = data;
266 process->comms = xbt_fifo_new();
267 process->simcall.issuer = process;
268 /* Initiliaze data segment to default value */
269 SIMIX_segment_index_set(process, -1);
271 if (parent_process != nullptr) {
272 process->ppid = parent_process->pid;
273 /* SMPI process have their own data segment and each other inherit from their father */
275 if( smpi_privatize_global_variables) {
276 if (parent_process->pid != 0) {
277 SIMIX_segment_index_set(process, parent_process->segment_index);
279 SIMIX_segment_index_set(process, process->pid - 1);
287 /* Process data for auto-restart */
288 process->auto_restart = auto_restart;
289 process->code = code;
291 XBT_VERB("Create context %s", process->name.c_str());
292 process->context = SIMIX_context_new(
294 simix_global->cleanup_process_function, process);
297 process->properties = properties;
299 /* Add the process to it's host process list */
300 xbt_swag_insert(process, sg_host_simix(host)->process_list);
302 XBT_DEBUG("Start context '%s'", process->name.c_str());
304 /* Now insert it in the global process list and in the process to run list */
305 xbt_swag_insert(process, simix_global->process_list);
306 XBT_DEBUG("Inserting %s(%s) in the to_run list",
307 process->name.c_str(), sg_host_get_name(host));
308 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
310 if (kill_time > SIMIX_get_clock() && simix_global->kill_process_function) {
311 XBT_DEBUG("Process %s(%s) will be kill at time %f",
312 process->name.c_str(), sg_host_get_name(process->host), kill_time);
313 process->kill_timer = SIMIX_timer_set(kill_time, [=]() {
314 simix_global->kill_process_function(process);
318 /* Tracing the process creation */
319 TRACE_msg_process_create(process->name.c_str(), process->pid, process->host);
324 smx_actor_t SIMIX_process_attach(
327 const char* hostname,
328 xbt_dict_t properties,
329 smx_actor_t parent_process)
331 // This is mostly a copy/paste from SIMIX_process_new(),
332 // it'd be nice to share some code between those two functions.
334 sg_host_t host = sg_host_by_name(hostname);
335 XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
338 XBT_WARN("Cannot launch process '%s' on failed host '%s'",
343 smx_actor_t process = new simgrid::simix::ActorImpl();
345 process->pid = simix_process_maxpid++;
346 process->name = std::string(name);
347 process->host = host;
348 process->data = data;
349 process->comms = xbt_fifo_new();
350 process->simcall.issuer = process;
352 /* Initiliaze data segment to default value */
353 SIMIX_segment_index_set(process, -1);
354 if (parent_process != nullptr) {
355 process->ppid = parent_process->pid;
356 /* SMPI process have their own data segment and each other inherit from their father */
358 if (smpi_privatize_global_variables) {
359 if (parent_process->pid != 0) {
360 SIMIX_segment_index_set(process, parent_process->segment_index);
362 SIMIX_segment_index_set(process, process->pid - 1);
368 /* Process data for auto-restart */
369 process->auto_restart = false;
370 process->code = nullptr;
372 XBT_VERB("Create context %s", process->name.c_str());
374 xbt_die("simix is not initialized, please call MSG_init first");
375 process->context = simix_global->context_factory->attach(
376 simix_global->cleanup_process_function, process);
379 process->properties = properties;
381 /* Add the process to it's host process list */
382 xbt_swag_insert(process, sg_host_simix(host)->process_list);
384 /* Now insert it in the global process list and in the process to run list */
385 xbt_swag_insert(process, simix_global->process_list);
386 XBT_DEBUG("Inserting %s(%s) in the to_run list",
387 process->name.c_str(), sg_host_get_name(host));
388 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
390 /* Tracing the process creation */
391 TRACE_msg_process_create(process->name.c_str(), process->pid, process->host);
393 auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(process->context);
395 xbt_die("Not a suitable context");
397 context->attach_start();
401 void SIMIX_process_detach()
403 auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(SIMIX_context_self());
405 xbt_die("Not a suitable context");
407 simix_global->cleanup_process_function(context->process());
409 // Let maestro ignore we are still alive:
410 // xbt_swag_remove(context->process(), simix_global->process_list);
412 // TODO, Remove from proces list:
413 // xbt_swag_remove(process, sg_host_simix(host)->process_list);
415 context->attach_stop();
420 * \brief Executes the processes from simix_global->process_to_run.
422 * The processes of simix_global->process_to_run are run (in parallel if
423 * possible). On exit, simix_global->process_to_run is empty, and
424 * simix_global->process_that_ran contains the list of processes that just ran.
425 * The two lists are swapped so, be careful when using them before and after a
426 * call to this function.
428 void SIMIX_process_runall()
430 SIMIX_context_runall();
432 xbt_dynar_t tmp = simix_global->process_that_ran;
433 simix_global->process_that_ran = simix_global->process_to_run;
434 simix_global->process_to_run = tmp;
435 xbt_dynar_reset(simix_global->process_to_run);
438 void simcall_HANDLER_process_kill(smx_simcall_t simcall, smx_actor_t process) {
439 SIMIX_process_kill(process, simcall->issuer);
442 * \brief Internal function to kill a SIMIX process.
444 * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
445 * or directly for SIMIX internal purposes.
447 * \param process poor victim
448 * \param issuer the process which has sent the PROCESS_KILL. Important to not schedule twice the same process.
450 void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
452 XBT_DEBUG("Killing process %s on %s",
453 process->name.c_str(), sg_host_get_name(process->host));
455 process->context->iwannadie = 1;
456 process->blocked = 0;
457 process->suspended = 0;
458 process->exception = nullptr;
460 /* destroy the blocking synchro if any */
461 if (process->waiting_synchro) {
463 simgrid::kernel::activity::Exec *exec = dynamic_cast<simgrid::kernel::activity::Exec*>(process->waiting_synchro);
464 simgrid::kernel::activity::Comm *comm = dynamic_cast<simgrid::kernel::activity::Comm*>(process->waiting_synchro);
465 simgrid::kernel::activity::Sleep *sleep = dynamic_cast<simgrid::kernel::activity::Sleep*>(process->waiting_synchro);
466 simgrid::kernel::activity::Raw *raw = dynamic_cast<simgrid::kernel::activity::Raw*>(process->waiting_synchro);
467 simgrid::kernel::activity::Io *io = dynamic_cast<simgrid::kernel::activity::Io*>(process->waiting_synchro);
469 if (exec != nullptr) {
472 } else if (comm != nullptr) {
473 xbt_fifo_remove(process->comms, process->waiting_synchro);
476 // Remove first occurrence of &process->simcall:
477 auto i = boost::range::find(
478 process->waiting_synchro->simcalls,
480 if (i != process->waiting_synchro->simcalls.end())
481 process->waiting_synchro->simcalls.remove(&process->simcall);
485 } else if (sleep != nullptr) {
486 SIMIX_process_sleep_destroy(process->waiting_synchro);
488 } else if (raw != nullptr) {
489 SIMIX_synchro_stop_waiting(process, &process->simcall);
490 delete process->waiting_synchro;
492 } else if (io != nullptr) {
493 SIMIX_io_destroy(process->waiting_synchro);
497 switch (process->waiting_synchro->type) {
498 case SIMIX_SYNC_JOIN:
499 SIMIX_process_sleep_destroy(process->waiting_synchro);
503 process->waiting_synchro = nullptr;
505 if(!xbt_dynar_member(simix_global->process_to_run, &(process)) && process != issuer) {
506 XBT_DEBUG("Inserting %s in the to_run list", process->name.c_str());
507 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
511 /** @brief Ask another process to raise the given exception
513 * @param cat category of exception
514 * @param value value associated to the exception
515 * @param msg string information associated to the exception
517 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg) {
518 SMX_EXCEPTION(process, cat, value, msg);
520 if (process->suspended)
521 SIMIX_process_resume(process);
523 /* cancel the blocking synchro if any */
524 if (process->waiting_synchro) {
526 simgrid::kernel::activity::Exec *exec = dynamic_cast<simgrid::kernel::activity::Exec*>(process->waiting_synchro);
527 if (exec != nullptr) {
528 SIMIX_execution_cancel(process->waiting_synchro);
531 simgrid::kernel::activity::Comm *comm = dynamic_cast<simgrid::kernel::activity::Comm*>(process->waiting_synchro);
532 if (comm != nullptr) {
533 xbt_fifo_remove(process->comms, comm);
537 simgrid::kernel::activity::Sleep *sleep = dynamic_cast<simgrid::kernel::activity::Sleep*>(process->waiting_synchro);
538 if (sleep != nullptr) {
539 SIMIX_process_sleep_destroy(process->waiting_synchro);
540 if (!xbt_dynar_member(simix_global->process_to_run, &(process)) && process != SIMIX_process_self()) {
541 XBT_DEBUG("Inserting %s in the to_run list", process->name.c_str());
542 xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
546 simgrid::kernel::activity::Raw *raw = dynamic_cast<simgrid::kernel::activity::Raw*>(process->waiting_synchro);
547 if (raw != nullptr) {
548 SIMIX_synchro_stop_waiting(process, &process->simcall);
551 simgrid::kernel::activity::Io *io = dynamic_cast<simgrid::kernel::activity::Io*>(process->waiting_synchro);
553 SIMIX_io_destroy(process->waiting_synchro);
556 process->waiting_synchro = nullptr;
560 void simcall_HANDLER_process_killall(smx_simcall_t simcall, int reset_pid) {
561 SIMIX_process_killall(simcall->issuer, reset_pid);
564 * \brief Kills all running processes.
565 * \param issuer this one will not be killed
567 void SIMIX_process_killall(smx_actor_t issuer, int reset_pid)
569 smx_actor_t p = nullptr;
571 while ((p = (smx_actor_t) xbt_swag_extract(simix_global->process_list))) {
573 SIMIX_process_kill(p,issuer);
578 simix_process_maxpid = reset_pid;
580 SIMIX_context_runall();
582 SIMIX_process_empty_trash();
585 void simcall_HANDLER_process_set_host(smx_simcall_t simcall, smx_actor_t process, sg_host_t dest)
587 process->new_host = dest;
589 void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest)
591 xbt_assert((process != nullptr), "Invalid parameters");
592 xbt_swag_remove(process, sg_host_simix(process->host)->process_list);
593 process->host = dest;
594 xbt_swag_insert(process, sg_host_simix(dest)->process_list);
598 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t process)
600 smx_activity_t sync_suspend = SIMIX_process_suspend(process, simcall->issuer);
602 if (process != simcall->issuer) {
603 SIMIX_simcall_answer(simcall);
605 sync_suspend->simcalls.push_back(simcall);
606 process->waiting_synchro = sync_suspend;
607 process->waiting_synchro->suspend();
609 /* If we are suspending ourselves, then just do not finish the simcall now */
612 smx_activity_t SIMIX_process_suspend(smx_actor_t process, smx_actor_t issuer)
614 if (process->suspended) {
615 XBT_DEBUG("Process '%s' is already suspended", process->name.c_str());
619 process->suspended = 1;
621 /* If we are suspending another process that is waiting on a sync, suspend its synchronization. */
622 if (process != issuer) {
624 if (process->waiting_synchro)
625 process->waiting_synchro->suspend();
626 /* If the other process is not waiting, its suspension is delayed to when the process is rescheduled. */
630 return SIMIX_execution_start(process, "suspend", 0.0, 1.0, 0.0);
634 void simcall_HANDLER_process_resume(smx_simcall_t simcall, smx_actor_t process){
635 SIMIX_process_resume(process);
638 void SIMIX_process_resume(smx_actor_t process)
640 XBT_IN("process = %p", process);
642 if(process->context->iwannadie) {
643 XBT_VERB("Ignoring request to suspend a process that is currently dying.");
647 if(!process->suspended) return;
648 process->suspended = 0;
650 /* resume the synchronization that was blocking the resumed process. */
651 if (process->waiting_synchro)
652 process->waiting_synchro->resume();
657 int SIMIX_process_get_maxpid() {
658 return simix_process_maxpid;
661 int SIMIX_process_count()
663 return xbt_swag_size(simix_global->process_list);
666 int SIMIX_process_get_PID(smx_actor_t self)
674 void* SIMIX_process_self_get_data()
676 smx_actor_t self = SIMIX_process_self();
681 return SIMIX_process_get_data(self);
684 void SIMIX_process_self_set_data(void *data)
686 smx_actor_t self = SIMIX_process_self();
688 SIMIX_process_set_data(self, data);
691 void* SIMIX_process_get_data(smx_actor_t process)
693 return process->data;
696 void SIMIX_process_set_data(smx_actor_t process, void *data)
698 process->data = data;
701 /* needs to be public and without simcall because it is called
702 by exceptions and logging events */
703 const char* SIMIX_process_self_get_name() {
705 smx_actor_t process = SIMIX_process_self();
706 if (process == nullptr || process == simix_global->maestro_process)
709 return process->name.c_str();
712 smx_actor_t SIMIX_process_get_by_name(const char* name)
715 xbt_swag_foreach(proc, simix_global->process_list) {
716 if (proc->name == name)
722 int SIMIX_process_is_suspended(smx_actor_t process)
724 return process->suspended;
727 xbt_dict_t SIMIX_process_get_properties(smx_actor_t process)
729 return process->properties;
732 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
734 if (process->finished) {
735 // The joined process is already finished, just wake up the issuer process right away
736 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
737 SIMIX_simcall_answer(simcall);
740 smx_activity_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
741 sync->simcalls.push_back(simcall);
742 simcall->issuer->waiting_synchro = sync;
745 static int SIMIX_process_join_finish(smx_process_exit_status_t status, smx_activity_t synchro){
746 simgrid::kernel::activity::Sleep *sleep = static_cast<simgrid::kernel::activity::Sleep*>(synchro);
748 if (sleep->surf_sleep) {
749 sleep->surf_sleep->cancel();
751 while (!sleep->simcalls.empty()) {
752 smx_simcall_t simcall = sleep->simcalls.front();
753 sleep->simcalls.pop_front();
754 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
755 simcall->issuer->waiting_synchro = nullptr;
756 if (simcall->issuer->suspended) {
757 XBT_DEBUG("Wait! This process is suspended and can't wake up now.");
758 simcall->issuer->suspended = 0;
759 simcall_HANDLER_process_suspend(simcall, simcall->issuer);
761 SIMIX_simcall_answer(simcall);
764 sleep->surf_sleep->unref();
765 sleep->surf_sleep = nullptr;
771 smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout)
773 smx_activity_t res = SIMIX_process_sleep(issuer, timeout);
774 static_cast<simgrid::kernel::activity::ActivityImpl*>(res)->ref();
775 SIMIX_process_on_exit(process, (int_f_pvoid_pvoid_t)SIMIX_process_join_finish, res);
779 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
781 if (MC_is_active() || MC_record_replay_is_active()) {
782 MC_process_clock_add(simcall->issuer, duration);
783 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
784 SIMIX_simcall_answer(simcall);
787 smx_activity_t sync = SIMIX_process_sleep(simcall->issuer, duration);
788 sync->simcalls.push_back(simcall);
789 simcall->issuer->waiting_synchro = sync;
792 smx_activity_t SIMIX_process_sleep(smx_actor_t process, double duration)
794 sg_host_t host = process->host;
796 /* check if the host is active */
798 THROWF(host_error, 0, "Host %s failed, you cannot call this function", sg_host_get_name(host));
800 simgrid::kernel::activity::Sleep *synchro = new simgrid::kernel::activity::Sleep();
801 synchro->host = host;
802 synchro->surf_sleep = surf_host_sleep(host, duration);
803 synchro->surf_sleep->setData(synchro);
804 XBT_DEBUG("Create sleep synchronization %p", synchro);
809 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
811 XBT_DEBUG("Destroy synchro %p", synchro);
812 simgrid::kernel::activity::Sleep *sleep = static_cast<simgrid::kernel::activity::Sleep*>(synchro);
814 if (sleep->surf_sleep) {
815 sleep->surf_sleep->unref();
816 sleep->surf_sleep = nullptr;
822 * \brief Calling this function makes the process to yield.
824 * Only the current process can call this function, giving back the control to
827 * \param self the current process
829 void SIMIX_process_yield(smx_actor_t self)
831 XBT_DEBUG("Yield process '%s'", self->name.c_str());
833 /* Go into sleep and return control to maestro */
834 self->context->suspend();
836 /* Ok, maestro returned control to us */
837 XBT_DEBUG("Control returned to me: '%s'", self->name.c_str());
839 if (self->new_host) {
840 SIMIX_process_change_host(self, self->new_host);
841 self->new_host = nullptr;
844 if (self->context->iwannadie){
845 XBT_DEBUG("I wanna die!");
846 SIMIX_process_stop(self);
849 if (self->suspended) {
850 XBT_DEBUG("Hey! I'm suspended.");
851 xbt_assert(self->exception != nullptr, "Gasp! This exception may be lost by subsequent calls.");
853 SIMIX_process_suspend(self, self);
856 if (self->exception != nullptr) {
857 XBT_DEBUG("Wait, maestro left me an exception");
858 std::exception_ptr exception = std::move(self->exception);
859 self->exception = nullptr;
860 std::rethrow_exception(std::move(exception));
863 if(SMPI_switch_data_segment && self->segment_index != -1){
864 SMPI_switch_data_segment(self->segment_index);
868 /* callback: termination */
869 void SIMIX_process_exception_terminate(xbt_ex_t * e)
875 smx_context_t SIMIX_process_get_context(smx_actor_t p) {
879 void SIMIX_process_set_context(smx_actor_t p,smx_context_t c) {
884 * \brief Returns the list of processes to run.
886 xbt_dynar_t SIMIX_process_get_runnable()
888 return simix_global->process_to_run;
892 * \brief Returns the process from PID.
894 smx_actor_t SIMIX_process_from_PID(int PID)
897 xbt_swag_foreach(proc, simix_global->process_list) {
898 if (proc->pid == static_cast<unsigned long> (PID))
904 /** @brief returns a dynar containing all currently existing processes */
905 xbt_dynar_t SIMIX_processes_as_dynar() {
907 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t),nullptr);
908 xbt_swag_foreach(proc, simix_global->process_list) {
909 xbt_dynar_push(res,&proc);
914 void SIMIX_process_on_exit_runall(smx_actor_t process) {
915 s_smx_process_exit_fun_t exit_fun;
916 smx_process_exit_status_t exit_status = (process->context->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
917 while (!xbt_dynar_is_empty(process->on_exit)) {
918 exit_fun = xbt_dynar_pop_as(process->on_exit,s_smx_process_exit_fun_t);
919 (exit_fun.fun)((void*)exit_status, exit_fun.arg);
923 void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data) {
924 xbt_assert(process, "current process not found: are you in maestro context ?");
926 if (!process->on_exit) {
927 process->on_exit = xbt_dynar_new(sizeof(s_smx_process_exit_fun_t), nullptr);
930 s_smx_process_exit_fun_t exit_fun = {fun, data};
932 xbt_dynar_push_as(process->on_exit,s_smx_process_exit_fun_t,exit_fun);
936 * \brief Sets the auto-restart status of the process.
937 * If set to 1, the process will be automatically restarted when its host
940 void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart) {
941 process->auto_restart = auto_restart;
944 smx_actor_t simcall_HANDLER_process_restart(smx_simcall_t simcall, smx_actor_t process) {
945 return SIMIX_process_restart(process, simcall->issuer);
947 /** @brief Restart a process, starting it again from the beginning. */
948 smx_actor_t SIMIX_process_restart(smx_actor_t process, smx_actor_t issuer) {
949 XBT_DEBUG("Restarting process %s on %s", process->name.c_str(), sg_host_get_name(process->host));
951 //retrieve the arguments of the old process
952 //FIXME: Factorize this with SIMIX_host_add_auto_restart_process ?
953 simgrid::simix::ProcessArg arg;
954 arg.name = process->name;
955 arg.code = process->code;
956 arg.host = process->host;
957 arg.kill_time = SIMIX_timer_get_date(process->kill_timer);
958 arg.data = process->data;
959 arg.properties = nullptr;
960 arg.auto_restart = process->auto_restart;
962 //kill the old process
963 SIMIX_process_kill(process, issuer);
965 //start the new process
966 return simix_global->create_process_function(arg.name.c_str(), std::move(arg.code), arg.data, arg.host,
967 arg.kill_time, arg.properties, arg.auto_restart, nullptr);
970 void SIMIX_segment_index_set(smx_actor_t proc, int index){
971 proc->segment_index = index;
975 * \ingroup simix_process_management
976 * \brief Creates and runs a new SIMIX process.
978 * The structure and the corresponding thread are created and put in the list of ready processes.
980 * \param name a name for the process. It is for user-level information and can be nullptr.
981 * \param code the main function of the process
982 * \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.
983 * It can be retrieved with the function \ref simcall_process_get_data.
984 * \param hostname name of the host where the new agent is executed.
985 * \param kill_time time when the process is killed
986 * \param argc first argument passed to \a code
987 * \param argv second argument passed to \a code
988 * \param properties the properties of the process
989 * \param auto_restart either it is autorestarting or not.
991 smx_actor_t simcall_process_create(const char *name,
992 xbt_main_func_t code,
996 int argc, char **argv,
997 xbt_dict_t properties,
1000 if (name == nullptr)
1002 auto wrapped_code = simgrid::xbt::wrapMain(code, argc, argv);
1003 for (int i = 0; i != argc; ++i)
1006 smx_actor_t res = simcall_process_create(name,
1007 std::move(wrapped_code),
1008 data, host, kill_time, properties, auto_restart);
1012 smx_actor_t simcall_process_create(
1013 const char *name, std::function<void()> code, void *data,
1014 sg_host_t host, double kill_time,
1015 xbt_dict_t properties, int auto_restart)
1017 if (name == nullptr)
1019 smx_actor_t self = SIMIX_process_self();
1020 return simgrid::simix::kernelImmediate([&] {
1021 return SIMIX_process_create(name, std::move(code), data, host, kill_time, properties, auto_restart, self);