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. */
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 Move a process to the list of processes to destroy.
35 void SIMIX_process_cleanup(smx_process_t process)
37 XBT_DEBUG("Cleanup process %s (%p), waiting action %p",
38 process->name, process, process->waiting_action);
40 /* cancel non-blocking communications */
42 while ((action = xbt_fifo_pop(process->comms))) {
44 /* make sure no one will finish the comm after this process is destroyed */
45 SIMIX_comm_cancel(action);
47 if (action->comm.src_proc == process) {
48 XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p",
49 action, action->comm.detached, action->state, action->comm.src_proc, action->comm.dst_proc);
50 action->comm.src_proc = NULL;
52 if (action->comm.detached) {
53 if (action->comm.refcount == 0) {
54 /* I'm not supposed to destroy a detached comm from the sender side,
55 * unless there is no receiver matching the rdv */
56 action->comm.refcount++;
57 SIMIX_comm_destroy(action);
61 SIMIX_comm_destroy(action);
64 else if (action->comm.dst_proc == process){
65 XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p",
66 action, action->state, action->comm.src_proc, action->comm.dst_proc);
67 action->comm.dst_proc = NULL;
69 if (action->comm.detached && action->comm.refcount == 1
70 && action->comm.src_proc != NULL) {
71 /* the comm will be freed right now, remove it from the sender */
72 xbt_fifo_remove(action->comm.src_proc->comms, action);
74 SIMIX_comm_destroy(action);
77 xbt_die("Communication action %p is in my list but I'm not the sender "
78 "or the receiver", action);
82 /*xbt_swag_remove(process, simix_global->process_to_run);*/
83 xbt_swag_remove(process, simix_global->process_list);
84 xbt_swag_remove(process, process->smx_host->process_list);
85 xbt_swag_insert(process, simix_global->process_to_destroy);
91 * Should be called some time to time to free the memory allocated for processes
92 * that have finished (or killed).
94 void SIMIX_process_empty_trash(void)
96 smx_process_t process = NULL;
98 while ((process = xbt_swag_extract(simix_global->process_to_destroy))) {
99 SIMIX_context_free(process->context);
101 /* Free the exception allocated at creation time */
102 free(process->running_ctx);
103 xbt_dict_free(&process->properties);
105 xbt_fifo_free(process->comms);
113 * \brief Creates and runs the maestro process
115 void SIMIX_create_maestro_process()
117 smx_process_t maestro = NULL;
119 /* Create maestro process and intilialize it */
120 maestro = xbt_new0(s_smx_process_t, 1);
121 maestro->pid = simix_process_maxpid++;
122 maestro->name = (char *) "";
123 maestro->running_ctx = xbt_new(xbt_running_ctx_t, 1);
124 XBT_RUNNING_CTX_INITIALIZE(maestro->running_ctx);
125 maestro->context = SIMIX_context_new(NULL, 0, NULL, NULL, maestro);
126 maestro->request.issuer = maestro;
128 simix_global->maestro_process = maestro;
133 * \brief Same as SIMIX_process_create() but with only one argument (used by timers).
134 * \return the process created
136 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args) {
138 smx_process_t process;
139 simix_global->create_process_function(
153 * \brief Internal function to create a process.
155 * This function actually creates the process.
156 * It may be called when a REQ_PROCESS_CREATE request occurs,
157 * or directly for SIMIX internal purposes.
159 * \return the process created
161 void SIMIX_process_create(smx_process_t *process,
163 xbt_main_func_t code,
165 const char *hostname,
166 int argc, char **argv,
167 xbt_dict_t properties) {
170 smx_host_t host = SIMIX_host_get_by_name(hostname);
172 XBT_DEBUG("Start process %s on host %s", name, hostname);
174 if (!SIMIX_host_get_state(host)) {
175 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name,
179 *process = xbt_new0(s_smx_process_t, 1);
181 xbt_assert(((code != NULL) && (host != NULL)), "Invalid parameters");
184 (*process)->pid = simix_process_maxpid++;
185 (*process)->name = xbt_strdup(name);
186 (*process)->smx_host = host;
187 (*process)->data = data;
188 (*process)->comms = xbt_fifo_new();
190 XBT_VERB("Create context %s", (*process)->name);
191 (*process)->context = SIMIX_context_new(code, argc, argv,
192 simix_global->cleanup_process_function, *process);
194 (*process)->running_ctx = xbt_new(xbt_running_ctx_t, 1);
195 XBT_RUNNING_CTX_INITIALIZE((*process)->running_ctx);
198 (*process)->properties = properties;
200 /* Add the process to it's host process list */
201 xbt_swag_insert(*process, host->process_list);
203 XBT_DEBUG("Start context '%s'", (*process)->name);
205 /* Now insert it in the global process list and in the process to run list */
206 xbt_swag_insert(*process, simix_global->process_list);
207 XBT_DEBUG("Inserting %s(%s) in the to_run list", (*process)->name, host->name);
208 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, *process);
213 * \brief Executes the processes from simix_global->process_to_run.
215 * The processes of simix_global->process_to_run are run (in parallel if
216 * possible). On exit, simix_global->process_to_run is empty, and
217 * simix_global->process_that_ran contains the list of processes that just ran.
218 * The two lists are swapped so, be careful when using them before and after a
219 * call to this function.
221 void SIMIX_process_runall(void)
223 SIMIX_context_runall();
225 xbt_dynar_t tmp = simix_global->process_that_ran;
226 simix_global->process_that_ran = simix_global->process_to_run;
227 simix_global->process_to_run = tmp;
228 xbt_dynar_reset(simix_global->process_to_run);
232 * \brief Internal function to kill a SIMIX process.
234 * This function may be called when a REQ_PROCESS_KILL request occurs,
235 * or directly for SIMIX internal purposes.
237 * \param process poor victim
239 void SIMIX_process_kill(smx_process_t process) {
241 XBT_DEBUG("Killing process %s on %s", process->name, process->smx_host->name);
243 process->context->iwannadie = 1;
244 process->blocked = 0;
245 process->suspended = 0;
246 /* FIXME: set doexception to 0 also? */
248 /* destroy the blocking action if any */
249 if (process->waiting_action) {
251 switch (process->waiting_action->type) {
253 case SIMIX_ACTION_EXECUTE:
254 case SIMIX_ACTION_PARALLEL_EXECUTE:
255 SIMIX_host_execution_destroy(process->waiting_action);
258 case SIMIX_ACTION_COMMUNICATE:
259 SIMIX_comm_destroy(process->waiting_action);
262 case SIMIX_ACTION_SLEEP:
263 SIMIX_process_sleep_destroy(process->waiting_action);
266 case SIMIX_ACTION_SYNCHRO:
267 SIMIX_synchro_stop_waiting(process, &process->request);
268 SIMIX_synchro_destroy(process->waiting_action);
271 case SIMIX_ACTION_IO:
277 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
281 * \brief Kills all running processes.
282 * \param issuer this one will not be killed
284 void SIMIX_process_killall(smx_process_t issuer)
286 smx_process_t p = NULL;
288 while ((p = xbt_swag_extract(simix_global->process_list))) {
290 SIMIX_process_kill(p);
294 SIMIX_context_runall(simix_global->process_to_run);
296 SIMIX_process_empty_trash();
299 void SIMIX_process_change_host(smx_process_t process,
302 xbt_assert((process != NULL), "Invalid parameters");
303 xbt_swag_remove(process, process->smx_host->process_list);
304 process->smx_host = dest;
305 xbt_swag_insert(process, dest->process_list);
308 void SIMIX_pre_process_change_host(smx_process_t process, smx_host_t dest)
310 process->new_host = dest;
313 void SIMIX_pre_process_suspend(smx_req_t req)
315 smx_process_t process = req->process_suspend.process;
316 SIMIX_process_suspend(process, req->issuer);
318 if (process != req->issuer) {
319 SIMIX_request_answer(req);
321 /* If we are suspending ourselves, then just do not replay the request. */
324 void SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
326 xbt_assert((process != NULL), "Invalid parameters");
328 if (process->suspended) {
329 XBT_DEBUG("Process '%s' is already suspended", process->name);
333 process->suspended = 1;
335 /* If we are suspending another process, and it is waiting on an action,
336 suspend its action. */
337 if (process != issuer) {
339 if (process->waiting_action) {
341 switch (process->waiting_action->type) {
343 case SIMIX_ACTION_EXECUTE:
344 case SIMIX_ACTION_PARALLEL_EXECUTE:
345 SIMIX_host_execution_suspend(process->waiting_action);
348 case SIMIX_ACTION_COMMUNICATE:
349 SIMIX_comm_suspend(process->waiting_action);
352 case SIMIX_ACTION_SLEEP:
353 SIMIX_process_sleep_suspend(process->waiting_action);
357 xbt_die("Internal error in SIMIX_process_suspend: unexpected action type %d",
358 process->waiting_action->type);
364 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
366 xbt_assert((process != NULL), "Invalid parameters");
368 if (!process->suspended) {
369 XBT_DEBUG("Process '%s' is not suspended", process->name);
373 process->suspended = 0;
375 /* If we are resuming another process, resume the action it was waiting for
376 if any. Otherwise add it to the list of process to run in the next round. */
377 if (process != issuer) {
379 if (process->waiting_action) {
381 switch (process->waiting_action->type) {
383 case SIMIX_ACTION_EXECUTE:
384 case SIMIX_ACTION_PARALLEL_EXECUTE:
385 SIMIX_host_execution_resume(process->waiting_action);
388 case SIMIX_ACTION_COMMUNICATE:
389 SIMIX_comm_resume(process->waiting_action);
392 case SIMIX_ACTION_SLEEP:
393 SIMIX_process_sleep_resume(process->waiting_action);
397 xbt_die("Internal error in SIMIX_process_resume: unexpected action type %d",
398 process->waiting_action->type);
402 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
407 int SIMIX_process_get_maxpid(void) {
408 return simix_process_maxpid;
411 int SIMIX_process_count(void)
413 return xbt_swag_size(simix_global->process_list);
416 void* SIMIX_process_self_get_data(void)
418 smx_process_t me = SIMIX_process_self();
422 return SIMIX_process_get_data(me);
425 void SIMIX_process_self_set_data(void *data)
427 SIMIX_process_set_data(SIMIX_process_self(), data);
430 void* SIMIX_process_get_data(smx_process_t process)
432 return process->data;
435 void SIMIX_process_set_data(smx_process_t process, void *data)
437 process->data = data;
440 smx_host_t SIMIX_process_get_host(smx_process_t process)
442 return process->smx_host;
445 /* needs to be public and without request because it is called
446 by exceptions and logging events */
447 const char* SIMIX_process_self_get_name(void) {
449 smx_process_t process = SIMIX_process_self();
450 if (process == NULL || process == simix_global->maestro_process)
453 return SIMIX_process_get_name(process);
456 const char* SIMIX_process_get_name(smx_process_t process)
458 return process->name;
461 smx_process_t SIMIX_process_get_by_name(const char* name)
465 xbt_swag_foreach(proc, simix_global->process_list)
467 if(!strcmp(name, proc->name))
473 int SIMIX_process_is_suspended(smx_process_t process)
475 return process->suspended;
478 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
480 return process->properties;
483 void SIMIX_pre_process_sleep(smx_req_t req)
486 MC_process_clock_add(req->issuer, req->process_sleep.duration);
487 req->process_sleep.result = SIMIX_DONE;
488 SIMIX_request_answer(req);
491 smx_action_t action = SIMIX_process_sleep(req->issuer, req->process_sleep.duration);
492 xbt_fifo_push(action->request_list, req);
493 req->issuer->waiting_action = action;
496 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
499 smx_host_t host = process->smx_host;
501 /* check if the host is active */
502 if (surf_workstation_model->extension.
503 workstation.get_state(host->host) != SURF_RESOURCE_ON) {
504 THROWF(host_error, 0, "Host %s failed, you cannot call this function",
508 action = xbt_mallocator_get(simix_global->action_mallocator);
509 action->type = SIMIX_ACTION_SLEEP;
512 action->category = NULL;
515 action->sleep.host = host;
516 action->sleep.surf_sleep =
517 surf_workstation_model->extension.workstation.sleep(host->host, duration);
519 surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
520 XBT_DEBUG("Create sleep action %p", action);
525 void SIMIX_post_process_sleep(smx_action_t action)
530 while ((req = xbt_fifo_shift(action->request_list))) {
532 switch(surf_workstation_model->action_state_get(action->sleep.surf_sleep)){
533 case SURF_ACTION_FAILED:
534 state = SIMIX_SRC_HOST_FAILURE;
537 case SURF_ACTION_DONE:
545 req->process_sleep.result = state;
546 req->issuer->waiting_action = NULL;
547 SIMIX_request_answer(req);
549 SIMIX_process_sleep_destroy(action);
552 void SIMIX_process_sleep_destroy(smx_action_t action)
554 XBT_DEBUG("Destroy action %p", action);
555 if (action->sleep.surf_sleep)
556 action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
557 xbt_mallocator_release(simix_global->action_mallocator, action);
560 void SIMIX_process_sleep_suspend(smx_action_t action)
562 surf_workstation_model->suspend(action->sleep.surf_sleep);
565 void SIMIX_process_sleep_resume(smx_action_t action)
567 surf_workstation_model->resume(action->sleep.surf_sleep);
571 * Calling this function makes the process to yield.
572 * Only the processes can call this function, giving back the control to maestro
574 void SIMIX_process_yield(void)
576 smx_process_t self = SIMIX_process_self();
578 XBT_DEBUG("Yield process '%s'", self->name);
580 /* Go into sleep and return control to maestro */
581 SIMIX_context_suspend(self->context);
583 /* Ok, maestro returned control to us */
584 XBT_DEBUG("Control returned to me: '%s'", self->name);
586 if (self->context->iwannadie){
587 XBT_DEBUG("I wanna die!");
588 SIMIX_context_stop(self->context);
591 if (self->doexception) {
592 XBT_DEBUG("Wait, maestro left me an exception");
593 self->doexception = 0;
597 if (self->new_host) {
598 SIMIX_process_change_host(self, self->new_host);
599 self->new_host = NULL;
603 /* callback: context fetching */
604 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
606 return SIMIX_process_self()->running_ctx;
609 /* callback: termination */
610 void SIMIX_process_exception_terminate(xbt_ex_t * e)
616 smx_context_t SIMIX_process_get_context(smx_process_t p) {
620 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {