1 /* Copyright (c) 2007, 2008, 2009, 2010. 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. */
7 #include "smx_private.h"
8 #include "xbt/sysdep.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
14 "Logging specific to SIMIX (process)");
16 unsigned long simix_process_maxpid = 0;
19 * \brief Returns the current agent.
21 * This functions returns the currently running SIMIX process.
23 * \return The SIMIX process
25 XBT_INLINE smx_process_t SIMIX_process_self(void)
27 smx_context_t self_context = SIMIX_context_self();
29 return self_context ? SIMIX_context_get_data(self_context) : NULL;
33 * \brief Returns whether a process has pending asynchronous communications.
34 * \return true if there are asynchronous communications in this process
36 int SIMIX_process_has_pending_comms(smx_process_t process) {
38 return xbt_fifo_size(process->comms) > 0;
42 * \brief Moves a process to the list of processes to destroy.
44 void SIMIX_process_cleanup(smx_process_t process)
46 XBT_DEBUG("Cleanup process %s (%p), waiting action %p",
47 process->name, process, process->waiting_action);
49 /* cancel non-blocking communications */
51 while ((action = xbt_fifo_pop(process->comms))) {
53 /* make sure no one will finish the comm after this process is destroyed,
54 * because src_proc or dst_proc would be an invalid pointer */
55 SIMIX_comm_cancel(action);
57 if (action->comm.src_proc == process) {
58 XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p",
59 action, action->comm.detached, (int)action->state, action->comm.src_proc, action->comm.dst_proc);
60 action->comm.src_proc = NULL;
62 if (action->comm.detached) {
63 if (action->comm.refcount == 0) {
64 XBT_DEBUG("Increase the refcount before destroying it since it's detached");
65 /* I'm not supposed to destroy a detached comm from the sender side,
66 * unless there is no receiver matching the rdv */
67 action->comm.refcount++;
68 SIMIX_comm_destroy(action);
71 XBT_DEBUG("Don't destroy it since its refcount is %d", action->comm.refcount);
74 SIMIX_comm_destroy(action);
77 else if (action->comm.dst_proc == process){
78 XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p",
79 action, (int)action->state, action->comm.src_proc, action->comm.dst_proc);
80 action->comm.dst_proc = NULL;
82 if (action->comm.detached && action->comm.refcount == 1
83 && action->comm.src_proc != NULL) {
84 /* the comm will be freed right now, remove it from the sender */
85 xbt_fifo_remove(action->comm.src_proc->comms, action);
87 SIMIX_comm_destroy(action);
90 xbt_die("Communication action %p is in my list but I'm not the sender "
91 "or the receiver", action);
95 /*xbt_swag_remove(process, simix_global->process_to_run);*/
96 xbt_swag_remove(process, simix_global->process_list);
97 xbt_swag_remove(process, process->smx_host->process_list);
98 xbt_swag_insert(process, simix_global->process_to_destroy);
99 process->context->iwannadie = 0;
105 * Should be called some time to time to free the memory allocated for processes
106 * that have finished (or killed).
108 void SIMIX_process_empty_trash(void)
110 smx_process_t process = NULL;
112 while ((process = xbt_swag_extract(simix_global->process_to_destroy))) {
113 SIMIX_context_free(process->context);
115 /* Free the exception allocated at creation time */
116 free(process->running_ctx);
117 xbt_dict_free(&process->properties);
119 xbt_fifo_free(process->comms);
121 xbt_dynar_free(&process->on_exit);
129 * \brief Creates and runs the maestro process
131 void SIMIX_create_maestro_process()
133 smx_process_t maestro = NULL;
135 /* Create maestro process and intilialize it */
136 maestro = xbt_new0(s_smx_process_t, 1);
137 maestro->pid = simix_process_maxpid++;
138 maestro->name = (char *) "";
139 maestro->running_ctx = xbt_new(xbt_running_ctx_t, 1);
140 XBT_RUNNING_CTX_INITIALIZE(maestro->running_ctx);
141 maestro->context = SIMIX_context_new(NULL, 0, NULL, NULL, maestro);
142 maestro->simcall.issuer = maestro;
144 simix_global->maestro_process = maestro;
149 * \brief Same as SIMIX_process_create() but with only one argument (used by timers).
150 * \return the process created
152 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args) {
154 smx_process_t process;
155 simix_global->create_process_function(
170 * \brief Internal function to create a process.
172 * This function actually creates the process.
173 * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
174 * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
176 * \return the process created
178 void SIMIX_process_create(smx_process_t *process,
180 xbt_main_func_t code,
182 const char *hostname,
184 int argc, char **argv,
185 xbt_dict_t properties) {
188 smx_host_t host = SIMIX_host_get_by_name(hostname);
190 XBT_DEBUG("Start process %s on host %s", name, hostname);
192 if (!SIMIX_host_get_state(host)) {
193 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name,
197 *process = xbt_new0(s_smx_process_t, 1);
199 xbt_assert(((code != NULL) && (host != NULL)), "Invalid parameters");
202 (*process)->pid = simix_process_maxpid++;
203 (*process)->name = xbt_strdup(name);
204 (*process)->smx_host = host;
205 (*process)->data = data;
206 (*process)->comms = xbt_fifo_new();
207 (*process)->simcall.issuer = *process;
209 XBT_VERB("Create context %s", (*process)->name);
210 (*process)->context = SIMIX_context_new(code, argc, argv,
211 simix_global->cleanup_process_function, *process);
213 (*process)->running_ctx = xbt_new(xbt_running_ctx_t, 1);
214 XBT_RUNNING_CTX_INITIALIZE((*process)->running_ctx);
217 (*process)->properties = properties;
219 /* Add the process to it's host process list */
220 xbt_swag_insert(*process, host->process_list);
222 XBT_DEBUG("Start context '%s'", (*process)->name);
224 /* Now insert it in the global process list and in the process to run list */
225 xbt_swag_insert(*process, simix_global->process_list);
226 XBT_DEBUG("Inserting %s(%s) in the to_run list", (*process)->name, host->name);
227 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, *process);
230 if (kill_time > SIMIX_get_clock()) {
231 if (simix_global->kill_process_function) {
232 XBT_DEBUG("Process %s(%s) will be kill at time %f", (*process)->name,
233 (*process)->smx_host->name, kill_time);
234 SIMIX_timer_set(kill_time, simix_global->kill_process_function, *process);
240 * \brief Executes the processes from simix_global->process_to_run.
242 * The processes of simix_global->process_to_run are run (in parallel if
243 * possible). On exit, simix_global->process_to_run is empty, and
244 * simix_global->process_that_ran contains the list of processes that just ran.
245 * The two lists are swapped so, be careful when using them before and after a
246 * call to this function.
248 void SIMIX_process_runall(void)
250 SIMIX_context_runall();
252 xbt_dynar_t tmp = simix_global->process_that_ran;
253 simix_global->process_that_ran = simix_global->process_to_run;
254 simix_global->process_to_run = tmp;
255 xbt_dynar_reset(simix_global->process_to_run);
259 * \brief Internal function to kill a SIMIX process.
261 * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
262 * or directly for SIMIX internal purposes.
264 * \param process poor victim
266 void SIMIX_process_kill(smx_process_t process) {
268 XBT_DEBUG("Killing process %s on %s", process->name, process->smx_host->name);
270 process->context->iwannadie = 1;
271 process->blocked = 0;
272 process->suspended = 0;
273 /* FIXME: set doexception to 0 also? */
275 /* destroy the blocking action if any */
276 if (process->waiting_action) {
278 switch (process->waiting_action->type) {
280 case SIMIX_ACTION_EXECUTE:
281 case SIMIX_ACTION_PARALLEL_EXECUTE:
282 SIMIX_host_execution_destroy(process->waiting_action);
285 case SIMIX_ACTION_COMMUNICATE:
286 xbt_fifo_remove(process->comms, process->waiting_action);
287 SIMIX_comm_destroy(process->waiting_action);
290 case SIMIX_ACTION_SLEEP:
291 SIMIX_process_sleep_destroy(process->waiting_action);
294 case SIMIX_ACTION_SYNCHRO:
295 SIMIX_synchro_stop_waiting(process, &process->simcall);
296 SIMIX_synchro_destroy(process->waiting_action);
299 case SIMIX_ACTION_IO:
300 SIMIX_io_destroy(process->waiting_action);
304 if(!xbt_dynar_member(simix_global->process_to_run, &(process)))
305 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
309 * \brief Kills all running processes.
310 * \param issuer this one will not be killed
312 void SIMIX_process_killall(smx_process_t issuer)
314 smx_process_t p = NULL;
316 while ((p = xbt_swag_extract(simix_global->process_list))) {
318 SIMIX_process_kill(p);
322 SIMIX_context_runall();
324 SIMIX_process_empty_trash();
327 void SIMIX_process_change_host(smx_process_t process,
330 xbt_assert((process != NULL), "Invalid parameters");
331 xbt_swag_remove(process, process->smx_host->process_list);
332 process->smx_host = dest;
333 xbt_swag_insert(process, dest->process_list);
336 void SIMIX_pre_process_change_host(smx_process_t process, smx_host_t dest)
338 process->new_host = dest;
341 void SIMIX_pre_process_suspend(smx_simcall_t simcall)
343 smx_process_t process = simcall->process_suspend.process;
344 smx_action_t action_suspend =
345 SIMIX_process_suspend(process, simcall->issuer);
347 if (process != simcall->issuer) {
348 SIMIX_simcall_answer(simcall);
350 xbt_fifo_push(action_suspend->simcalls, simcall);
351 process->waiting_action = action_suspend;
352 SIMIX_host_execution_suspend(process->waiting_action);
354 /* If we are suspending ourselves, then just do not finish the simcall now */
357 smx_action_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
359 xbt_assert((process != NULL), "Invalid parameters");
361 if (process->suspended) {
362 XBT_DEBUG("Process '%s' is already suspended", process->name);
366 process->suspended = 1;
368 /* If we are suspending another process, and it is waiting on an action,
369 suspend its action. */
370 if (process != issuer) {
372 if (process->waiting_action) {
374 switch (process->waiting_action->type) {
376 case SIMIX_ACTION_EXECUTE:
377 case SIMIX_ACTION_PARALLEL_EXECUTE:
378 SIMIX_host_execution_suspend(process->waiting_action);
381 case SIMIX_ACTION_COMMUNICATE:
382 SIMIX_comm_suspend(process->waiting_action);
385 case SIMIX_ACTION_SLEEP:
386 SIMIX_process_sleep_suspend(process->waiting_action);
389 case SIMIX_ACTION_SYNCHRO:
390 /* Suspension is delayed to when the process is rescheduled. */
394 xbt_die("Internal error in SIMIX_process_suspend: unexpected action type %d",
395 (int)process->waiting_action->type);
399 /* Suspension is delayed to when the process is rescheduled. */
403 return SIMIX_host_execute("suspend", process->smx_host, 0.0, 1.0);
407 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
409 xbt_assert((process != NULL), "Invalid parameters");
411 XBT_IN("process = %p, issuer = %p", process, issuer);
413 if(process->context->iwannadie) {
414 XBT_VERB("Ignoring request to suspend a process that is currently dying.");
418 if(!process->suspended) return;
419 process->suspended = 0;
421 /* If we are resuming another process, resume the action it was waiting for
422 if any. Otherwise add it to the list of process to run in the next round. */
423 if (process != issuer) {
425 if (process->waiting_action) {
427 switch (process->waiting_action->type) {
429 case SIMIX_ACTION_EXECUTE:
430 case SIMIX_ACTION_PARALLEL_EXECUTE:
431 SIMIX_host_execution_resume(process->waiting_action);
434 case SIMIX_ACTION_COMMUNICATE:
435 SIMIX_comm_resume(process->waiting_action);
438 case SIMIX_ACTION_SLEEP:
439 SIMIX_process_sleep_resume(process->waiting_action);
442 case SIMIX_ACTION_SYNCHRO:
443 /* I cannot resume it now. This is delayed to when the process is rescheduled at
444 * the end of the synchro. */
448 xbt_die("Internal error in SIMIX_process_resume: unexpected action type %d",
449 (int)process->waiting_action->type);
452 } else XBT_WARN("Strange. Process %p is trying to resume himself.", issuer);
457 int SIMIX_process_get_maxpid(void) {
458 return simix_process_maxpid;
461 int SIMIX_process_count(void)
463 return xbt_swag_size(simix_global->process_list);
466 void* SIMIX_process_self_get_data(smx_process_t self)
468 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
473 return SIMIX_process_get_data(self);
476 void SIMIX_process_self_set_data(smx_process_t self, void *data)
478 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
480 SIMIX_process_set_data(self, data);
483 void* SIMIX_process_get_data(smx_process_t process)
485 return process->data;
488 void SIMIX_process_set_data(smx_process_t process, void *data)
490 process->data = data;
493 smx_host_t SIMIX_process_get_host(smx_process_t process)
495 return process->smx_host;
498 /* needs to be public and without simcall because it is called
499 by exceptions and logging events */
500 const char* SIMIX_process_self_get_name(void) {
502 smx_process_t process = SIMIX_process_self();
503 if (process == NULL || process == simix_global->maestro_process)
506 return SIMIX_process_get_name(process);
509 const char* SIMIX_process_get_name(smx_process_t process)
511 return process->name;
514 smx_process_t SIMIX_process_get_by_name(const char* name)
518 xbt_swag_foreach(proc, simix_global->process_list)
520 if(!strcmp(name, proc->name))
526 int SIMIX_process_is_suspended(smx_process_t process)
528 return process->suspended;
531 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
533 return process->properties;
536 void SIMIX_pre_process_sleep(smx_simcall_t simcall)
539 MC_process_clock_add(simcall->issuer, simcall->process_sleep.duration);
540 simcall->process_sleep.result = SIMIX_DONE;
541 SIMIX_simcall_answer(simcall);
544 smx_action_t action = SIMIX_process_sleep(simcall->issuer, simcall->process_sleep.duration);
545 xbt_fifo_push(action->simcalls, simcall);
546 simcall->issuer->waiting_action = action;
549 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
552 smx_host_t host = process->smx_host;
554 /* check if the host is active */
555 if (surf_workstation_model->extension.
556 workstation.get_state(host->host) != SURF_RESOURCE_ON) {
557 THROWF(host_error, 0, "Host %s failed, you cannot call this function",
561 action = xbt_mallocator_get(simix_global->action_mallocator);
562 action->type = SIMIX_ACTION_SLEEP;
565 action->category = NULL;
568 action->sleep.host = host;
569 action->sleep.surf_sleep =
570 surf_workstation_model->extension.workstation.sleep(host->host, duration);
572 surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
573 XBT_DEBUG("Create sleep action %p", action);
578 void SIMIX_post_process_sleep(smx_action_t action)
580 smx_simcall_t simcall;
583 while ((simcall = xbt_fifo_shift(action->simcalls))) {
585 switch(surf_workstation_model->action_state_get(action->sleep.surf_sleep)){
586 case SURF_ACTION_FAILED:
587 simcall->issuer->context->iwannadie = 1;
588 //SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
591 case SURF_ACTION_DONE:
599 if (surf_workstation_model->extension.
600 workstation.get_state(simcall->issuer->smx_host->host) != SURF_RESOURCE_ON) {
601 simcall->issuer->context->iwannadie = 1;
603 simcall->process_sleep.result = state;
604 simcall->issuer->waiting_action = NULL;
605 SIMIX_simcall_answer(simcall);
608 SIMIX_process_sleep_destroy(action);
611 void SIMIX_process_sleep_destroy(smx_action_t action)
613 XBT_DEBUG("Destroy action %p", action);
614 if (action->sleep.surf_sleep)
615 action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
616 xbt_mallocator_release(simix_global->action_mallocator, action);
619 void SIMIX_process_sleep_suspend(smx_action_t action)
621 surf_workstation_model->suspend(action->sleep.surf_sleep);
624 void SIMIX_process_sleep_resume(smx_action_t action)
626 surf_workstation_model->resume(action->sleep.surf_sleep);
630 * \brief Calling this function makes the process to yield.
632 * Only the current process can call this function, giving back the control to
635 * \param self the current process
637 void SIMIX_process_yield(smx_process_t self)
639 XBT_DEBUG("Yield process '%s'", self->name);
641 /* Go into sleep and return control to maestro */
642 SIMIX_context_suspend(self->context);
644 /* Ok, maestro returned control to us */
645 XBT_DEBUG("Control returned to me: '%s'", self->name);
647 if (self->new_host) {
648 SIMIX_process_change_host(self, self->new_host);
649 self->new_host = NULL;
652 if (self->context->iwannadie){
653 XBT_DEBUG("I wanna die!");
654 SIMIX_context_stop(self->context);
657 if(self->suspended) {
658 xbt_assert(!self->doexception, "Gloups! This exception may be lost by subsequent calls.");
660 SIMIX_process_suspend(self,self);
663 if (self->doexception) {
664 XBT_DEBUG("Wait, maestro left me an exception");
665 self->doexception = 0;
670 /* callback: context fetching */
671 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
673 return SIMIX_process_self()->running_ctx;
676 /* callback: termination */
677 void SIMIX_process_exception_terminate(xbt_ex_t * e)
683 smx_context_t SIMIX_process_get_context(smx_process_t p) {
687 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {
692 * \brief Returns the list of processes to run.
694 xbt_dynar_t SIMIX_process_get_runnable(void)
696 return simix_global->process_to_run;
700 * \brief Returns the process from PID.
702 smx_process_t SIMIX_process_from_PID(int PID)
705 xbt_swag_foreach(proc, simix_global->process_list)
713 /** @brief returns a dynar containg all currently existing processes */
714 xbt_dynar_t SIMIX_processes_as_dynar(void) {
716 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_process_t),NULL);
717 xbt_swag_foreach(proc, simix_global->process_list) {
718 xbt_dynar_push(res,&proc);
722 void SIMIX_process_on_exit_runall(smx_process_t process) {
723 s_smx_process_exit_fun_t exit_fun;
725 while (!xbt_dynar_is_empty(process->on_exit)) {
726 exit_fun = xbt_dynar_pop_as(process->on_exit,s_smx_process_exit_fun_t);
727 (exit_fun.fun)(exit_fun.arg);
730 void SIMIX_process_on_exit(int_f_pvoid_t fun, void *data) {
731 smx_process_t process = SIMIX_process_self();
732 xbt_assert(process, "current process not found: are you in maestro context ?");
734 if (!process->on_exit) {
735 process->on_exit = xbt_dynar_new(sizeof(s_smx_process_exit_fun_t), NULL);
738 s_smx_process_exit_fun_t exit_fun = {fun, data};
740 xbt_dynar_push_as(process->on_exit,s_smx_process_exit_fun_t,exit_fun);