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.
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 /* Now insert it in the global process list and in the process to run list */
223 xbt_swag_insert(*process, simix_global->process_list);
224 XBT_DEBUG("Inserting %s(%s) in the to_run list", (*process)->name, host->name);
225 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, *process);
228 if (kill_time > SIMIX_get_clock()) {
229 if (simix_global->kill_process_function) {
230 XBT_DEBUG("Process %s(%s) will be kill at time %f", (*process)->name,
231 (*process)->smx_host->name, kill_time);
232 SIMIX_timer_set(kill_time, simix_global->kill_process_function, *process);
238 * \brief Executes the processes from simix_global->process_to_run.
240 * The processes of simix_global->process_to_run are run (in parallel if
241 * possible). On exit, simix_global->process_to_run is empty, and
242 * simix_global->process_that_ran contains the list of processes that just ran.
243 * The two lists are swapped so, be careful when using them before and after a
244 * call to this function.
246 void SIMIX_process_runall(void)
248 SIMIX_context_runall();
250 xbt_dynar_t tmp = simix_global->process_that_ran;
251 simix_global->process_that_ran = simix_global->process_to_run;
252 simix_global->process_to_run = tmp;
253 xbt_dynar_reset(simix_global->process_to_run);
257 * \brief Internal function to kill a SIMIX process.
259 * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
260 * or directly for SIMIX internal purposes.
262 * \param process poor victim
264 void SIMIX_process_kill(smx_process_t process) {
266 XBT_DEBUG("Killing process %s on %s", process->name, process->smx_host->name);
268 process->context->iwannadie = 1;
269 process->blocked = 0;
270 process->suspended = 0;
271 /* FIXME: set doexception to 0 also? */
273 /* destroy the blocking action if any */
274 if (process->waiting_action) {
276 switch (process->waiting_action->type) {
278 case SIMIX_ACTION_EXECUTE:
279 case SIMIX_ACTION_PARALLEL_EXECUTE:
280 SIMIX_host_execution_destroy(process->waiting_action);
283 case SIMIX_ACTION_COMMUNICATE:
284 xbt_fifo_remove(process->comms, process->waiting_action);
285 SIMIX_comm_destroy(process->waiting_action);
288 case SIMIX_ACTION_SLEEP:
289 SIMIX_process_sleep_destroy(process->waiting_action);
292 case SIMIX_ACTION_SYNCHRO:
293 SIMIX_synchro_stop_waiting(process, &process->simcall);
294 SIMIX_synchro_destroy(process->waiting_action);
297 case SIMIX_ACTION_IO:
298 SIMIX_io_destroy(process->waiting_action);
302 if(!xbt_dynar_member(simix_global->process_to_run, &(process)))
303 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
307 * \brief Kills all running processes.
308 * \param issuer this one will not be killed
310 void SIMIX_process_killall(smx_process_t issuer)
312 smx_process_t p = NULL;
314 while ((p = xbt_swag_extract(simix_global->process_list))) {
316 SIMIX_process_kill(p);
320 SIMIX_context_runall();
322 SIMIX_process_empty_trash();
325 void SIMIX_process_change_host(smx_process_t process,
328 xbt_assert((process != NULL), "Invalid parameters");
329 xbt_swag_remove(process, process->smx_host->process_list);
330 process->smx_host = dest;
331 xbt_swag_insert(process, dest->process_list);
334 void SIMIX_pre_process_change_host(smx_process_t process, smx_host_t dest)
336 process->new_host = dest;
339 void SIMIX_pre_process_suspend(smx_simcall_t simcall)
341 smx_process_t process = simcall->process_suspend.process;
342 smx_action_t action_suspend =
343 SIMIX_process_suspend(process, simcall->issuer);
345 if (process != simcall->issuer) {
346 SIMIX_simcall_answer(simcall);
348 xbt_fifo_push(action_suspend->simcalls, simcall);
349 process->waiting_action = action_suspend;
350 SIMIX_host_execution_suspend(process->waiting_action);
352 /* If we are suspending ourselves, then just do not finish the simcall now */
355 smx_action_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
357 xbt_assert((process != NULL), "Invalid parameters");
359 if (process->suspended) {
360 XBT_DEBUG("Process '%s' is already suspended", process->name);
364 process->suspended = 1;
366 /* If we are suspending another process, and it is waiting on an action,
367 suspend its action. */
368 if (process != issuer) {
370 if (process->waiting_action) {
372 switch (process->waiting_action->type) {
374 case SIMIX_ACTION_EXECUTE:
375 case SIMIX_ACTION_PARALLEL_EXECUTE:
376 SIMIX_host_execution_suspend(process->waiting_action);
379 case SIMIX_ACTION_COMMUNICATE:
380 SIMIX_comm_suspend(process->waiting_action);
383 case SIMIX_ACTION_SLEEP:
384 SIMIX_process_sleep_suspend(process->waiting_action);
387 case SIMIX_ACTION_SYNCHRO:
388 /* Suspension is delayed to when the process is rescheduled. */
392 xbt_die("Internal error in SIMIX_process_suspend: unexpected action type %d",
393 (int)process->waiting_action->type);
397 /* Suspension is delayed to when the process is rescheduled. */
401 return SIMIX_host_execute("suspend", process->smx_host, 0.0, 1.0);
405 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
407 xbt_assert((process != NULL), "Invalid parameters");
409 XBT_IN("process = %p, issuer = %p", process, issuer);
411 if(process->context->iwannadie)
414 if(!process->suspended) return;
415 process->suspended = 0;
417 /* If we are resuming another process, resume the action it was waiting for
418 if any. Otherwise add it to the list of process to run in the next round. */
419 if (process != issuer) {
421 if (process->waiting_action) {
423 switch (process->waiting_action->type) {
425 case SIMIX_ACTION_EXECUTE:
426 case SIMIX_ACTION_PARALLEL_EXECUTE:
427 SIMIX_host_execution_resume(process->waiting_action);
430 case SIMIX_ACTION_COMMUNICATE:
431 SIMIX_comm_resume(process->waiting_action);
434 case SIMIX_ACTION_SLEEP:
435 SIMIX_process_sleep_resume(process->waiting_action);
438 case SIMIX_ACTION_SYNCHRO:
439 /* I cannot resume it now. This is delayed to when the process is rescheduled at
440 * the end of the synchro. */
444 xbt_die("Internal error in SIMIX_process_resume: unexpected action type %d",
445 (int)process->waiting_action->type);
448 } else XBT_WARN("Strange. Process %p is trying to resume himself.", issuer);
453 int SIMIX_process_get_maxpid(void) {
454 return simix_process_maxpid;
457 int SIMIX_process_count(void)
459 return xbt_swag_size(simix_global->process_list);
462 void* SIMIX_process_self_get_data(smx_process_t self)
464 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
469 return SIMIX_process_get_data(self);
472 void SIMIX_process_self_set_data(smx_process_t self, void *data)
474 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
476 SIMIX_process_set_data(self, data);
479 void* SIMIX_process_get_data(smx_process_t process)
481 return process->data;
484 void SIMIX_process_set_data(smx_process_t process, void *data)
486 process->data = data;
489 smx_host_t SIMIX_process_get_host(smx_process_t process)
491 return process->smx_host;
494 /* needs to be public and without simcall because it is called
495 by exceptions and logging events */
496 const char* SIMIX_process_self_get_name(void) {
498 smx_process_t process = SIMIX_process_self();
499 if (process == NULL || process == simix_global->maestro_process)
502 return SIMIX_process_get_name(process);
505 const char* SIMIX_process_get_name(smx_process_t process)
507 return process->name;
510 smx_process_t SIMIX_process_get_by_name(const char* name)
514 xbt_swag_foreach(proc, simix_global->process_list)
516 if(!strcmp(name, proc->name))
522 int SIMIX_process_is_suspended(smx_process_t process)
524 return process->suspended;
527 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
529 return process->properties;
532 void SIMIX_pre_process_sleep(smx_simcall_t simcall)
535 MC_process_clock_add(simcall->issuer, simcall->process_sleep.duration);
536 simcall->process_sleep.result = SIMIX_DONE;
537 SIMIX_simcall_answer(simcall);
540 smx_action_t action = SIMIX_process_sleep(simcall->issuer, simcall->process_sleep.duration);
541 xbt_fifo_push(action->simcalls, simcall);
542 simcall->issuer->waiting_action = action;
545 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
548 smx_host_t host = process->smx_host;
550 /* check if the host is active */
551 if (surf_workstation_model->extension.
552 workstation.get_state(host->host) != SURF_RESOURCE_ON) {
553 THROWF(host_error, 0, "Host %s failed, you cannot call this function",
557 action = xbt_mallocator_get(simix_global->action_mallocator);
558 action->type = SIMIX_ACTION_SLEEP;
561 action->category = NULL;
564 action->sleep.host = host;
565 action->sleep.surf_sleep =
566 surf_workstation_model->extension.workstation.sleep(host->host, duration);
568 surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
569 XBT_DEBUG("Create sleep action %p", action);
574 void SIMIX_post_process_sleep(smx_action_t action)
576 smx_simcall_t simcall;
579 while ((simcall = xbt_fifo_shift(action->simcalls))) {
581 switch(surf_workstation_model->action_state_get(action->sleep.surf_sleep)){
582 case SURF_ACTION_FAILED:
583 state = SIMIX_SRC_HOST_FAILURE;
586 case SURF_ACTION_DONE:
594 simcall->process_sleep.result = state;
595 simcall->issuer->waiting_action = NULL;
596 SIMIX_simcall_answer(simcall);
598 SIMIX_process_sleep_destroy(action);
601 void SIMIX_process_sleep_destroy(smx_action_t action)
603 XBT_DEBUG("Destroy action %p", action);
604 if (action->sleep.surf_sleep)
605 action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
606 xbt_mallocator_release(simix_global->action_mallocator, action);
609 void SIMIX_process_sleep_suspend(smx_action_t action)
611 surf_workstation_model->suspend(action->sleep.surf_sleep);
614 void SIMIX_process_sleep_resume(smx_action_t action)
616 surf_workstation_model->resume(action->sleep.surf_sleep);
620 * \brief Calling this function makes the process to yield.
622 * Only the current process can call this function, giving back the control to
625 * \param self the current process
627 void SIMIX_process_yield(smx_process_t self)
629 XBT_DEBUG("Yield process '%s'", self->name);
631 /* Go into sleep and return control to maestro */
632 SIMIX_context_suspend(self->context);
634 /* Ok, maestro returned control to us */
635 XBT_DEBUG("Control returned to me: '%s'", self->name);
637 if (self->context->iwannadie){
638 XBT_DEBUG("I wanna die!");
639 SIMIX_context_stop(self->context);
642 if(self->suspended) {
643 xbt_assert(!self->doexception, "Gloups! This exception may be lost by subsequent calls.");
645 SIMIX_process_suspend(self,self);
648 if (self->doexception) {
649 XBT_DEBUG("Wait, maestro left me an exception");
650 self->doexception = 0;
654 if (self->new_host) {
655 SIMIX_process_change_host(self, self->new_host);
656 self->new_host = NULL;
660 /* callback: context fetching */
661 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
663 return SIMIX_process_self()->running_ctx;
666 /* callback: termination */
667 void SIMIX_process_exception_terminate(xbt_ex_t * e)
673 smx_context_t SIMIX_process_get_context(smx_process_t p) {
677 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {
682 * \brief Returns the list of processes to run.
684 xbt_dynar_t SIMIX_process_get_runnable(void)
686 return simix_global->process_to_run;
690 * \brief Returns the process from PID.
692 smx_process_t SIMIX_process_from_PID(int PID)
695 xbt_swag_foreach(proc, simix_global->process_list)
703 /** @brief returns a dynar containg all currently existing processes */
704 xbt_dynar_t SIMIX_processes_as_dynar(void) {
706 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_process_t),NULL);
707 xbt_swag_foreach(proc, simix_global->process_list) {
708 xbt_dynar_push(res,&proc);