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);
127 * \brief Creates and runs the maestro process
129 void SIMIX_create_maestro_process()
131 smx_process_t maestro = NULL;
133 /* Create maestro process and intilialize it */
134 maestro = xbt_new0(s_smx_process_t, 1);
135 maestro->pid = simix_process_maxpid++;
136 maestro->name = (char *) "";
137 maestro->running_ctx = xbt_new(xbt_running_ctx_t, 1);
138 XBT_RUNNING_CTX_INITIALIZE(maestro->running_ctx);
139 maestro->context = SIMIX_context_new(NULL, 0, NULL, NULL, maestro);
140 maestro->simcall.issuer = maestro;
142 simix_global->maestro_process = maestro;
147 * \brief Same as SIMIX_process_create() but with only one argument (used by timers).
148 * \return the process created
150 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args) {
152 smx_process_t process;
153 simix_global->create_process_function(
168 * \brief Internal function to create a process.
170 * This function actually creates the process.
171 * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
172 * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
174 * \return the process created
176 void SIMIX_process_create(smx_process_t *process,
178 xbt_main_func_t code,
180 const char *hostname,
182 int argc, char **argv,
183 xbt_dict_t properties) {
186 smx_host_t host = SIMIX_host_get_by_name(hostname);
188 XBT_DEBUG("Start process %s on host %s", name, hostname);
190 if (!SIMIX_host_get_state(host)) {
191 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name,
195 *process = xbt_new0(s_smx_process_t, 1);
197 xbt_assert(((code != NULL) && (host != NULL)), "Invalid parameters");
200 (*process)->pid = simix_process_maxpid++;
201 (*process)->name = xbt_strdup(name);
202 (*process)->smx_host = host;
203 (*process)->data = data;
204 (*process)->comms = xbt_fifo_new();
205 (*process)->simcall.issuer = *process;
207 XBT_VERB("Create context %s", (*process)->name);
208 (*process)->context = SIMIX_context_new(code, argc, argv,
209 simix_global->cleanup_process_function, *process);
211 (*process)->running_ctx = xbt_new(xbt_running_ctx_t, 1);
212 XBT_RUNNING_CTX_INITIALIZE((*process)->running_ctx);
215 (*process)->properties = properties;
217 /* Add the process to it's host process list */
218 xbt_swag_insert(*process, host->process_list);
220 XBT_DEBUG("Start context '%s'", (*process)->name);
222 /* Build the dynars for the on_exit functions */
223 (*process)->on_exit_fun = xbt_dynar_new(sizeof(int_f_pvoid_t),NULL);
224 (*process)->on_exit_args = xbt_dynar_new(sizeof(void*),NULL);
225 /* Now insert it in the global process list and in the process to run list */
226 xbt_swag_insert(*process, simix_global->process_list);
227 XBT_DEBUG("Inserting %s(%s) in the to_run list", (*process)->name, host->name);
228 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, *process);
231 if (kill_time > SIMIX_get_clock()) {
232 if (simix_global->kill_process_function) {
233 XBT_DEBUG("Process %s(%s) will be kill at time %f", (*process)->name,
234 (*process)->smx_host->name, kill_time);
235 SIMIX_timer_set(kill_time, simix_global->kill_process_function, *process);
241 * \brief Executes the processes from simix_global->process_to_run.
243 * The processes of simix_global->process_to_run are run (in parallel if
244 * possible). On exit, simix_global->process_to_run is empty, and
245 * simix_global->process_that_ran contains the list of processes that just ran.
246 * The two lists are swapped so, be careful when using them before and after a
247 * call to this function.
249 void SIMIX_process_runall(void)
251 SIMIX_context_runall();
253 xbt_dynar_t tmp = simix_global->process_that_ran;
254 simix_global->process_that_ran = simix_global->process_to_run;
255 simix_global->process_to_run = tmp;
256 xbt_dynar_reset(simix_global->process_to_run);
260 * \brief Internal function to kill a SIMIX process.
262 * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
263 * or directly for SIMIX internal purposes.
265 * \param process poor victim
267 void SIMIX_process_kill(smx_process_t process) {
269 XBT_DEBUG("Killing process %s on %s", process->name, process->smx_host->name);
271 process->context->iwannadie = 1;
272 process->blocked = 0;
273 process->suspended = 0;
274 /* FIXME: set doexception to 0 also? */
276 /* destroy the blocking action if any */
277 if (process->waiting_action) {
279 switch (process->waiting_action->type) {
281 case SIMIX_ACTION_EXECUTE:
282 case SIMIX_ACTION_PARALLEL_EXECUTE:
283 SIMIX_host_execution_destroy(process->waiting_action);
286 case SIMIX_ACTION_COMMUNICATE:
287 xbt_fifo_remove(process->comms, process->waiting_action);
288 SIMIX_comm_destroy(process->waiting_action);
291 case SIMIX_ACTION_SLEEP:
292 SIMIX_process_sleep_destroy(process->waiting_action);
295 case SIMIX_ACTION_SYNCHRO:
296 SIMIX_synchro_stop_waiting(process, &process->simcall);
297 SIMIX_synchro_destroy(process->waiting_action);
300 case SIMIX_ACTION_IO:
301 SIMIX_io_destroy(process->waiting_action);
305 if(!xbt_dynar_member(simix_global->process_to_run, &(process)))
306 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
310 * \brief Kills all running processes.
311 * \param issuer this one will not be killed
313 void SIMIX_process_killall(smx_process_t issuer)
315 smx_process_t p = NULL;
317 while ((p = xbt_swag_extract(simix_global->process_list))) {
319 SIMIX_process_kill(p);
323 SIMIX_context_runall();
325 SIMIX_process_empty_trash();
328 void SIMIX_process_change_host(smx_process_t process,
331 xbt_assert((process != NULL), "Invalid parameters");
332 xbt_swag_remove(process, process->smx_host->process_list);
333 process->smx_host = dest;
334 xbt_swag_insert(process, dest->process_list);
337 void SIMIX_pre_process_change_host(smx_process_t process, smx_host_t dest)
339 process->new_host = dest;
342 void SIMIX_pre_process_suspend(smx_simcall_t simcall)
344 smx_process_t process = simcall->process_suspend.process;
345 smx_action_t action_suspend =
346 SIMIX_process_suspend(process, simcall->issuer);
348 if (process != simcall->issuer) {
349 SIMIX_simcall_answer(simcall);
351 xbt_fifo_push(action_suspend->simcalls, simcall);
352 process->waiting_action = action_suspend;
353 SIMIX_host_execution_suspend(process->waiting_action);
355 /* If we are suspending ourselves, then just do not finish the simcall now */
358 smx_action_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
360 xbt_assert((process != NULL), "Invalid parameters");
362 if (process->suspended) {
363 XBT_DEBUG("Process '%s' is already suspended", process->name);
367 process->suspended = 1;
369 /* If we are suspending another process, and it is waiting on an action,
370 suspend its action. */
371 if (process != issuer) {
373 if (process->waiting_action) {
375 switch (process->waiting_action->type) {
377 case SIMIX_ACTION_EXECUTE:
378 case SIMIX_ACTION_PARALLEL_EXECUTE:
379 SIMIX_host_execution_suspend(process->waiting_action);
382 case SIMIX_ACTION_COMMUNICATE:
383 SIMIX_comm_suspend(process->waiting_action);
386 case SIMIX_ACTION_SLEEP:
387 SIMIX_process_sleep_suspend(process->waiting_action);
390 case SIMIX_ACTION_SYNCHRO:
391 /* Suspension is delayed to when the process is rescheduled. */
395 xbt_die("Internal error in SIMIX_process_suspend: unexpected action type %d",
396 (int)process->waiting_action->type);
400 /* Suspension is delayed to when the process is rescheduled. */
404 return SIMIX_host_execute("suspend", process->smx_host, 0.0, 1.0);
408 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
410 xbt_assert((process != NULL), "Invalid parameters");
412 XBT_IN("process = %p, issuer = %p", process, issuer);
414 if(process->context->iwannadie) {
415 XBT_VERB("Ignoring request to suspend a process that is currently dying.");
419 if(!process->suspended) return;
420 process->suspended = 0;
422 /* If we are resuming another process, resume the action it was waiting for
423 if any. Otherwise add it to the list of process to run in the next round. */
424 if (process != issuer) {
426 if (process->waiting_action) {
428 switch (process->waiting_action->type) {
430 case SIMIX_ACTION_EXECUTE:
431 case SIMIX_ACTION_PARALLEL_EXECUTE:
432 SIMIX_host_execution_resume(process->waiting_action);
435 case SIMIX_ACTION_COMMUNICATE:
436 SIMIX_comm_resume(process->waiting_action);
439 case SIMIX_ACTION_SLEEP:
440 SIMIX_process_sleep_resume(process->waiting_action);
443 case SIMIX_ACTION_SYNCHRO:
444 /* I cannot resume it now. This is delayed to when the process is rescheduled at
445 * the end of the synchro. */
449 xbt_die("Internal error in SIMIX_process_resume: unexpected action type %d",
450 (int)process->waiting_action->type);
453 } else XBT_WARN("Strange. Process %p is trying to resume himself.", issuer);
458 int SIMIX_process_get_maxpid(void) {
459 return simix_process_maxpid;
462 int SIMIX_process_count(void)
464 return xbt_swag_size(simix_global->process_list);
467 void* SIMIX_process_self_get_data(smx_process_t self)
469 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
474 return SIMIX_process_get_data(self);
477 void SIMIX_process_self_set_data(smx_process_t self, void *data)
479 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
481 SIMIX_process_set_data(self, data);
484 void* SIMIX_process_get_data(smx_process_t process)
486 return process->data;
489 void SIMIX_process_set_data(smx_process_t process, void *data)
491 process->data = data;
494 smx_host_t SIMIX_process_get_host(smx_process_t process)
496 return process->smx_host;
499 /* needs to be public and without simcall because it is called
500 by exceptions and logging events */
501 const char* SIMIX_process_self_get_name(void) {
503 smx_process_t process = SIMIX_process_self();
504 if (process == NULL || process == simix_global->maestro_process)
507 return SIMIX_process_get_name(process);
510 const char* SIMIX_process_get_name(smx_process_t process)
512 return process->name;
515 smx_process_t SIMIX_process_get_by_name(const char* name)
519 xbt_swag_foreach(proc, simix_global->process_list)
521 if(!strcmp(name, proc->name))
527 int SIMIX_process_is_suspended(smx_process_t process)
529 return process->suspended;
532 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
534 return process->properties;
537 void SIMIX_pre_process_sleep(smx_simcall_t simcall)
540 MC_process_clock_add(simcall->issuer, simcall->process_sleep.duration);
541 simcall->process_sleep.result = SIMIX_DONE;
542 SIMIX_simcall_answer(simcall);
545 smx_action_t action = SIMIX_process_sleep(simcall->issuer, simcall->process_sleep.duration);
546 xbt_fifo_push(action->simcalls, simcall);
547 simcall->issuer->waiting_action = action;
550 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
553 smx_host_t host = process->smx_host;
555 /* check if the host is active */
556 if (surf_workstation_model->extension.
557 workstation.get_state(host->host) != SURF_RESOURCE_ON) {
558 THROWF(host_error, 0, "Host %s failed, you cannot call this function",
562 action = xbt_mallocator_get(simix_global->action_mallocator);
563 action->type = SIMIX_ACTION_SLEEP;
566 action->category = NULL;
569 action->sleep.host = host;
570 action->sleep.surf_sleep =
571 surf_workstation_model->extension.workstation.sleep(host->host, duration);
573 surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
574 XBT_DEBUG("Create sleep action %p", action);
579 void SIMIX_post_process_sleep(smx_action_t action)
581 smx_simcall_t simcall;
584 while ((simcall = xbt_fifo_shift(action->simcalls))) {
586 switch(surf_workstation_model->action_state_get(action->sleep.surf_sleep)){
587 case SURF_ACTION_FAILED:
588 SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
591 case SURF_ACTION_DONE:
599 simcall->process_sleep.result = state;
600 simcall->issuer->waiting_action = NULL;
601 SIMIX_simcall_answer(simcall);
603 SIMIX_process_sleep_destroy(action);
606 void SIMIX_process_sleep_destroy(smx_action_t action)
608 XBT_DEBUG("Destroy action %p", action);
609 if (action->sleep.surf_sleep)
610 action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
611 xbt_mallocator_release(simix_global->action_mallocator, action);
614 void SIMIX_process_sleep_suspend(smx_action_t action)
616 surf_workstation_model->suspend(action->sleep.surf_sleep);
619 void SIMIX_process_sleep_resume(smx_action_t action)
621 surf_workstation_model->resume(action->sleep.surf_sleep);
625 * \brief Calling this function makes the process to yield.
627 * Only the current process can call this function, giving back the control to
630 * \param self the current process
632 void SIMIX_process_yield(smx_process_t self)
634 XBT_DEBUG("Yield process '%s'", self->name);
636 /* Go into sleep and return control to maestro */
637 SIMIX_context_suspend(self->context);
639 /* Ok, maestro returned control to us */
640 XBT_DEBUG("Control returned to me: '%s'", self->name);
642 if (self->context->iwannadie){
643 XBT_DEBUG("I wanna die!");
644 SIMIX_context_stop(self->context);
647 if(self->suspended) {
648 xbt_assert(!self->doexception, "Gloups! This exception may be lost by subsequent calls.");
650 SIMIX_process_suspend(self,self);
653 if (self->doexception) {
654 XBT_DEBUG("Wait, maestro left me an exception");
655 self->doexception = 0;
659 if (self->new_host) {
660 SIMIX_process_change_host(self, self->new_host);
661 self->new_host = NULL;
665 /* callback: context fetching */
666 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
668 return SIMIX_process_self()->running_ctx;
671 /* callback: termination */
672 void SIMIX_process_exception_terminate(xbt_ex_t * e)
678 smx_context_t SIMIX_process_get_context(smx_process_t p) {
682 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {
687 * \brief Returns the list of processes to run.
689 xbt_dynar_t SIMIX_process_get_runnable(void)
691 return simix_global->process_to_run;
695 * \brief Returns the process from PID.
697 smx_process_t SIMIX_process_from_PID(int PID)
700 xbt_swag_foreach(proc, simix_global->process_list)
708 /** @brief returns a dynar containg all currently existing processes */
709 xbt_dynar_t SIMIX_processes_as_dynar(void) {
711 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_process_t),NULL);
712 xbt_swag_foreach(proc, simix_global->process_list) {
713 xbt_dynar_push(res,&proc);
717 void SIMIX_process_on_exit(smx_process_t process) {
718 int length = xbt_dynar_length(process->on_exit_fun);
722 for (cpt = 0; cpt < length; cpt++) {
723 fun = xbt_dynar_get_as(process->on_exit_fun,cpt,int_f_pvoid_t);
724 data = xbt_dynar_get_as(process->on_exit_args,cpt,void*);
728 void SIMIX_process_on_exit_add(int_f_pvoid_t fun, void *data) {
729 smx_process_t process = SIMIX_process_self();
730 xbt_assert(process, "current process not found: are you in maestro context ?");
731 xbt_dynar_push_as(process->on_exit_fun,int_f_pvoid_t,fun);
732 xbt_dynar_push_as(process->on_exit_args,void*,data);