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);
104 * Should be called some time to time to free the memory allocated for processes
105 * that have finished (or killed).
107 void SIMIX_process_empty_trash(void)
109 smx_process_t process = NULL;
111 while ((process = xbt_swag_extract(simix_global->process_to_destroy))) {
112 SIMIX_context_free(process->context);
114 /* Free the exception allocated at creation time */
115 free(process->running_ctx);
116 xbt_dict_free(&process->properties);
118 xbt_fifo_free(process->comms);
126 * \brief Creates and runs the maestro process
128 void SIMIX_create_maestro_process()
130 smx_process_t maestro = NULL;
132 /* Create maestro process and intilialize it */
133 maestro = xbt_new0(s_smx_process_t, 1);
134 maestro->pid = simix_process_maxpid++;
135 maestro->name = (char *) "";
136 maestro->running_ctx = xbt_new(xbt_running_ctx_t, 1);
137 XBT_RUNNING_CTX_INITIALIZE(maestro->running_ctx);
138 maestro->context = SIMIX_context_new(NULL, 0, NULL, NULL, maestro);
139 maestro->simcall.issuer = maestro;
141 simix_global->maestro_process = maestro;
146 * \brief Same as SIMIX_process_create() but with only one argument (used by timers).
147 * \return the process created
149 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args) {
151 smx_process_t process;
152 simix_global->create_process_function(
166 * \brief Internal function to create a process.
168 * This function actually creates the process.
169 * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
170 * or directly for SIMIX internal purposes.
172 * \return the process created
174 void SIMIX_process_create(smx_process_t *process,
176 xbt_main_func_t code,
178 const char *hostname,
179 int argc, char **argv,
180 xbt_dict_t properties) {
183 smx_host_t host = SIMIX_host_get_by_name(hostname);
185 XBT_DEBUG("Start process %s on host %s", name, hostname);
187 if (!SIMIX_host_get_state(host)) {
188 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name,
192 *process = xbt_new0(s_smx_process_t, 1);
194 xbt_assert(((code != NULL) && (host != NULL)), "Invalid parameters");
197 (*process)->pid = simix_process_maxpid++;
198 (*process)->name = xbt_strdup(name);
199 (*process)->smx_host = host;
200 (*process)->data = data;
201 (*process)->comms = xbt_fifo_new();
202 (*process)->simcall.issuer = *process;
204 XBT_VERB("Create context %s", (*process)->name);
205 (*process)->context = SIMIX_context_new(code, argc, argv,
206 simix_global->cleanup_process_function, *process);
208 (*process)->running_ctx = xbt_new(xbt_running_ctx_t, 1);
209 XBT_RUNNING_CTX_INITIALIZE((*process)->running_ctx);
212 (*process)->properties = properties;
214 /* Add the process to it's host process list */
215 xbt_swag_insert(*process, host->process_list);
217 XBT_DEBUG("Start context '%s'", (*process)->name);
219 /* Now insert it in the global process list and in the process to run list */
220 xbt_swag_insert(*process, simix_global->process_list);
221 XBT_DEBUG("Inserting %s(%s) in the to_run list", (*process)->name, host->name);
222 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, *process);
227 * \brief Executes the processes from simix_global->process_to_run.
229 * The processes of simix_global->process_to_run are run (in parallel if
230 * possible). On exit, simix_global->process_to_run is empty, and
231 * simix_global->process_that_ran contains the list of processes that just ran.
232 * The two lists are swapped so, be careful when using them before and after a
233 * call to this function.
235 void SIMIX_process_runall(void)
237 SIMIX_context_runall();
239 xbt_dynar_t tmp = simix_global->process_that_ran;
240 simix_global->process_that_ran = simix_global->process_to_run;
241 simix_global->process_to_run = tmp;
242 xbt_dynar_reset(simix_global->process_to_run);
246 * \brief Internal function to kill a SIMIX process.
248 * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
249 * or directly for SIMIX internal purposes.
251 * \param process poor victim
253 void SIMIX_process_kill(smx_process_t process) {
255 XBT_DEBUG("Killing process %s on %s", process->name, process->smx_host->name);
257 process->context->iwannadie = 1;
258 process->blocked = 0;
259 process->suspended = 0;
260 /* FIXME: set doexception to 0 also? */
262 /* destroy the blocking action if any */
263 if (process->waiting_action) {
265 switch (process->waiting_action->type) {
267 case SIMIX_ACTION_EXECUTE:
268 case SIMIX_ACTION_PARALLEL_EXECUTE:
269 SIMIX_host_execution_destroy(process->waiting_action);
272 case SIMIX_ACTION_COMMUNICATE:
273 xbt_fifo_remove(process->comms, process->waiting_action);
274 SIMIX_comm_destroy(process->waiting_action);
277 case SIMIX_ACTION_SLEEP:
278 SIMIX_process_sleep_destroy(process->waiting_action);
281 case SIMIX_ACTION_SYNCHRO:
282 SIMIX_synchro_stop_waiting(process, &process->simcall);
283 SIMIX_synchro_destroy(process->waiting_action);
286 case SIMIX_ACTION_IO:
287 SIMIX_io_destroy(process->waiting_action);
292 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
296 * \brief Kills all running processes.
297 * \param issuer this one will not be killed
299 void SIMIX_process_killall(smx_process_t issuer)
301 smx_process_t p = NULL;
303 while ((p = xbt_swag_extract(simix_global->process_list))) {
305 SIMIX_process_kill(p);
309 SIMIX_context_runall();
311 SIMIX_process_empty_trash();
314 void SIMIX_process_change_host(smx_process_t process,
317 xbt_assert((process != NULL), "Invalid parameters");
318 xbt_swag_remove(process, process->smx_host->process_list);
319 process->smx_host = dest;
320 xbt_swag_insert(process, dest->process_list);
323 void SIMIX_pre_process_change_host(smx_process_t process, smx_host_t dest)
325 process->new_host = dest;
328 void SIMIX_pre_process_suspend(smx_simcall_t simcall)
330 smx_process_t process = simcall->process_suspend.process;
331 SIMIX_process_suspend(process, simcall->issuer);
333 if (process != simcall->issuer) {
334 SIMIX_simcall_answer(simcall);
336 /* If we are suspending ourselves, then just do not finish the simcall now */
339 void SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
341 xbt_assert((process != NULL), "Invalid parameters");
343 if (process->suspended) {
344 XBT_DEBUG("Process '%s' is already suspended", process->name);
348 process->suspended = 1;
350 /* If we are suspending another process, and it is waiting on an action,
351 suspend its action. */
352 if (process != issuer) {
354 if (process->waiting_action) {
356 switch (process->waiting_action->type) {
358 case SIMIX_ACTION_EXECUTE:
359 case SIMIX_ACTION_PARALLEL_EXECUTE:
360 SIMIX_host_execution_suspend(process->waiting_action);
363 case SIMIX_ACTION_COMMUNICATE:
364 SIMIX_comm_suspend(process->waiting_action);
367 case SIMIX_ACTION_SLEEP:
368 SIMIX_process_sleep_suspend(process->waiting_action);
372 xbt_die("Internal error in SIMIX_process_suspend: unexpected action type %d",
373 (int)process->waiting_action->type);
379 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
381 xbt_assert((process != NULL), "Invalid parameters");
383 if (!process->suspended) {
384 XBT_DEBUG("Process '%s' is not suspended", process->name);
388 process->suspended = 0;
390 /* If we are resuming another process, resume the action it was waiting for
391 if any. Otherwise add it to the list of process to run in the next round. */
392 if (process != issuer) {
394 if (process->waiting_action) {
396 switch (process->waiting_action->type) {
398 case SIMIX_ACTION_EXECUTE:
399 case SIMIX_ACTION_PARALLEL_EXECUTE:
400 SIMIX_host_execution_resume(process->waiting_action);
403 case SIMIX_ACTION_COMMUNICATE:
404 SIMIX_comm_resume(process->waiting_action);
407 case SIMIX_ACTION_SLEEP:
408 SIMIX_process_sleep_resume(process->waiting_action);
412 xbt_die("Internal error in SIMIX_process_resume: unexpected action type %d",
413 (int)process->waiting_action->type);
417 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
422 int SIMIX_process_get_maxpid(void) {
423 return simix_process_maxpid;
426 int SIMIX_process_count(void)
428 return xbt_swag_size(simix_global->process_list);
431 void* SIMIX_process_self_get_data(smx_process_t self)
433 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
438 return SIMIX_process_get_data(self);
441 void SIMIX_process_self_set_data(smx_process_t self, void *data)
443 xbt_assert(self == SIMIX_process_self(), "This is not the current process");
445 SIMIX_process_set_data(self, data);
448 void* SIMIX_process_get_data(smx_process_t process)
450 return process->data;
453 void SIMIX_process_set_data(smx_process_t process, void *data)
455 process->data = data;
458 smx_host_t SIMIX_process_get_host(smx_process_t process)
460 return process->smx_host;
463 /* needs to be public and without simcall because it is called
464 by exceptions and logging events */
465 const char* SIMIX_process_self_get_name(void) {
467 smx_process_t process = SIMIX_process_self();
468 if (process == NULL || process == simix_global->maestro_process)
471 return SIMIX_process_get_name(process);
474 const char* SIMIX_process_get_name(smx_process_t process)
476 return process->name;
479 smx_process_t SIMIX_process_get_by_name(const char* name)
483 xbt_swag_foreach(proc, simix_global->process_list)
485 if(!strcmp(name, proc->name))
491 int SIMIX_process_is_suspended(smx_process_t process)
493 return process->suspended;
496 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
498 return process->properties;
501 void SIMIX_pre_process_sleep(smx_simcall_t simcall)
504 MC_process_clock_add(simcall->issuer, simcall->process_sleep.duration);
505 simcall->process_sleep.result = SIMIX_DONE;
506 SIMIX_simcall_answer(simcall);
509 smx_action_t action = SIMIX_process_sleep(simcall->issuer, simcall->process_sleep.duration);
510 xbt_fifo_push(action->simcalls, simcall);
511 simcall->issuer->waiting_action = action;
514 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
517 smx_host_t host = process->smx_host;
519 /* check if the host is active */
520 if (surf_workstation_model->extension.
521 workstation.get_state(host->host) != SURF_RESOURCE_ON) {
522 THROWF(host_error, 0, "Host %s failed, you cannot call this function",
526 action = xbt_mallocator_get(simix_global->action_mallocator);
527 action->type = SIMIX_ACTION_SLEEP;
530 action->category = NULL;
533 action->sleep.host = host;
534 action->sleep.surf_sleep =
535 surf_workstation_model->extension.workstation.sleep(host->host, duration);
537 surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
538 XBT_DEBUG("Create sleep action %p", action);
543 void SIMIX_post_process_sleep(smx_action_t action)
545 smx_simcall_t simcall;
548 while ((simcall = xbt_fifo_shift(action->simcalls))) {
550 switch(surf_workstation_model->action_state_get(action->sleep.surf_sleep)){
551 case SURF_ACTION_FAILED:
552 state = SIMIX_SRC_HOST_FAILURE;
555 case SURF_ACTION_DONE:
563 simcall->process_sleep.result = state;
564 simcall->issuer->waiting_action = NULL;
565 SIMIX_simcall_answer(simcall);
567 SIMIX_process_sleep_destroy(action);
570 void SIMIX_process_sleep_destroy(smx_action_t action)
572 XBT_DEBUG("Destroy action %p", action);
573 if (action->sleep.surf_sleep)
574 action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
575 xbt_mallocator_release(simix_global->action_mallocator, action);
578 void SIMIX_process_sleep_suspend(smx_action_t action)
580 surf_workstation_model->suspend(action->sleep.surf_sleep);
583 void SIMIX_process_sleep_resume(smx_action_t action)
585 surf_workstation_model->resume(action->sleep.surf_sleep);
589 * \brief Calling this function makes the process to yield.
591 * Only the current process can call this function, giving back the control to
594 * \param self the current process
596 void SIMIX_process_yield(smx_process_t self)
598 XBT_DEBUG("Yield process '%s'", self->name);
600 /* Go into sleep and return control to maestro */
601 SIMIX_context_suspend(self->context);
603 /* Ok, maestro returned control to us */
604 XBT_DEBUG("Control returned to me: '%s'", self->name);
606 if (self->context->iwannadie){
607 XBT_DEBUG("I wanna die!");
608 SIMIX_context_stop(self->context);
611 if (self->doexception) {
612 XBT_DEBUG("Wait, maestro left me an exception");
613 self->doexception = 0;
617 if (self->new_host) {
618 SIMIX_process_change_host(self, self->new_host);
619 self->new_host = NULL;
623 /* callback: context fetching */
624 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
626 return SIMIX_process_self()->running_ctx;
629 /* callback: termination */
630 void SIMIX_process_exception_terminate(xbt_ex_t * e)
636 smx_context_t SIMIX_process_get_context(smx_process_t p) {
640 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {
645 * \brief Returns the list of processes to run.
647 xbt_dynar_t SIMIX_process_get_runnable(void)
649 return simix_global->process_to_run;
653 * \brief Returns the process from PID.
655 smx_process_t SIMIX_process_from_PID(int PID)
658 xbt_swag_foreach(proc, simix_global->process_list)
666 /** @brief returns a dynar containg all currently existing processes */
667 xbt_dynar_t SIMIX_processes_as_dynar(void) {
669 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_process_t),NULL);
670 xbt_swag_foreach(proc, simix_global->process_list) {
671 xbt_dynar_push(res,&proc);