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"
11 #include "msg/mailbox.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
15 "Logging specific to SIMIX (process)");
17 static unsigned long simix_process_count = 0;
20 * \brief Returns the current agent.
22 * This functions returns the currently running SIMIX process.
24 * \return The SIMIX process
26 XBT_INLINE smx_process_t SIMIX_process_self(void)
28 smx_context_t self_context = SIMIX_context_self();
30 return self_context ? SIMIX_context_get_data(self_context) : NULL;
34 * \brief Move a process to the list of processes to destroy.
36 void SIMIX_process_cleanup(smx_process_t process)
38 DEBUG1("Cleanup process %s", process->name);
39 xbt_swag_remove(process, simix_global->process_to_run);
40 xbt_swag_remove(process, simix_global->process_list);
41 xbt_swag_remove(process, process->smx_host->process_list);
42 xbt_swag_insert(process, simix_global->process_to_destroy);
48 * Should be called some time to time to free the memory allocated for processes
49 * that have finished (or killed).
51 void SIMIX_process_empty_trash(void)
53 smx_process_t process = NULL;
55 while ((process = xbt_swag_extract(simix_global->process_to_destroy))) {
56 SIMIX_context_free(process->context);
58 /* Free the exception allocated at creation time */
59 if (process->running_ctx)
60 free(process->running_ctx);
61 if (process->properties)
62 xbt_dict_free(&process->properties);
71 * \brief Creates and runs the maestro process
73 void SIMIX_create_maestro_process()
75 smx_process_t maestro = NULL;
77 /* Create maestro process and intilialize it */
78 maestro = xbt_new0(s_smx_process_t, 1);
79 maestro->pid = simix_process_count++;
80 maestro->name = (char *) "";
81 maestro->running_ctx = xbt_new(xbt_running_ctx_t, 1);
82 XBT_RUNNING_CTX_INITIALIZE(maestro->running_ctx);
83 maestro->context = SIMIX_context_new(NULL, 0, NULL, NULL, maestro);
85 simix_global->maestro_process = maestro;
90 * \brief Same as SIMIX_process_create() but with only one argument (used by timers).
91 * \return the process created
93 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args) {
95 smx_process_t process;
97 if (simix_global->create_process_function) {
98 process = simix_global->create_process_function(args->name,
107 process = SIMIX_process_create(args->name,
115 // FIXME: to simplify this, simix_global->create_process_function could just
116 // be SIMIX_process_create() by default (and the same thing in smx_deployment.c)
122 * \brief Internal function to create a process.
124 * This function actually creates the process.
125 * It may be called when a REQ_PROCESS_CREATE request occurs,
126 * or directly for SIMIX internal purposes.
128 * \return the process created
130 smx_process_t SIMIX_process_create(const char *name,
131 xbt_main_func_t code,
133 const char *hostname,
134 int argc, char **argv,
135 xbt_dict_t properties) {
137 smx_process_t process = NULL;
138 smx_host_t host = SIMIX_host_get_by_name(hostname);
140 DEBUG2("Start process %s on host %s", name, hostname);
142 if (!SIMIX_host_get_state(host)) {
143 WARN2("Cannot launch process '%s' on failed host '%s'", name,
147 process = xbt_new0(s_smx_process_t, 1);
149 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
152 process->pid = simix_process_count++;
153 process->name = xbt_strdup(name);
154 process->smx_host = host;
155 process->data = data;
157 VERB1("Create context %s", process->name);
158 process->context = SIMIX_context_new(code, argc, argv,
159 simix_global->cleanup_process_function, process);
161 process->running_ctx = xbt_new(xbt_running_ctx_t, 1);
162 XBT_RUNNING_CTX_INITIALIZE(process->running_ctx);
165 process->properties = properties;
167 /* Add the process to it's host process list */
168 xbt_swag_insert(process, host->process_list);
170 DEBUG1("Start context '%s'", process->name);
172 /* Now insert it in the global process list and in the process to run list */
173 xbt_swag_insert(process, simix_global->process_list);
174 DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
175 xbt_swag_insert(process, simix_global->process_to_run);
182 * \brief Internal function to kill a SIMIX process.
184 * This function may be called when a REQ_PROCESS_KILL request occurs,
185 * or directly for SIMIX internal purposes.
187 * \param process poor victim
189 void SIMIX_process_kill(smx_process_t process, smx_process_t killer) {
191 DEBUG2("Killing process %s on %s", process->name, process->smx_host->name);
193 process->context->iwannadie = 1;
194 process->blocked = 0;
195 process->suspended = 0;
196 /* FIXME: set doexception to 0 also? */
198 if (process->waiting_action) {
200 switch (process->waiting_action->type) {
202 case SIMIX_ACTION_EXECUTE:
203 case SIMIX_ACTION_PARALLEL_EXECUTE:
204 SIMIX_host_execution_destroy(process->waiting_action);
207 case SIMIX_ACTION_COMMUNICATE:
208 SIMIX_comm_destroy(process->waiting_action);
211 case SIMIX_ACTION_SLEEP:
212 SIMIX_process_sleep_destroy(process->waiting_action);
215 case SIMIX_ACTION_SYNCHRO:
216 SIMIX_synchro_stop_waiting(process, process->request);
217 SIMIX_synchro_destroy(process->waiting_action);
220 case SIMIX_ACTION_IO:
226 /* If I'm killing myself then stop, otherwise schedule the process to kill. */
227 if (process == killer) {
228 SIMIX_context_stop(process->context);
231 xbt_swag_insert(process, simix_global->process_to_run);
236 * \brief Kills all running processes.
238 * Only maestro can kill everyone.
240 void SIMIX_process_killall(void)
242 smx_process_t p = NULL;
244 while ((p = xbt_swag_extract(simix_global->process_list)))
245 SIMIX_process_kill(p, SIMIX_process_self());
247 SIMIX_process_empty_trash();
250 void SIMIX_process_change_host(smx_process_t process,
251 const char *source, const char *dest)
253 smx_host_t h1 = NULL;
254 smx_host_t h2 = NULL;
255 xbt_assert0((process != NULL), "Invalid parameters");
256 h1 = SIMIX_host_get_by_name(source);
257 h2 = SIMIX_host_get_by_name(dest);
258 process->smx_host = h2;
259 xbt_swag_remove(process, h1->process_list);
260 xbt_swag_insert(process, h2->process_list);
263 void SIMIX_pre_process_suspend(smx_req_t req)
265 smx_process_t process = req->process_suspend.process;
266 SIMIX_process_suspend(process, req->issuer);
268 if (process != req->issuer) {
269 SIMIX_request_answer(req);
271 /* If we are suspending ourselves, then just do not replay the request. */
274 void SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
276 xbt_assert0(process, "Invalid parameters");
278 process->suspended = 1;
280 /* If we are suspending another process, and it is waiting on an action,
281 suspend it's action. */
282 if (process != issuer) {
284 if (process->waiting_action) {
286 switch (process->waiting_action->type) {
288 case SIMIX_ACTION_EXECUTE:
289 case SIMIX_ACTION_PARALLEL_EXECUTE:
290 SIMIX_host_execution_suspend(process->waiting_action);
293 case SIMIX_ACTION_COMMUNICATE:
294 SIMIX_comm_suspend(process->waiting_action);
297 case SIMIX_ACTION_SLEEP:
298 SIMIX_process_sleep_suspend(process->waiting_action);
308 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
310 xbt_assert0((process != NULL), "Invalid parameters");
312 process->suspended = 0;
314 /* If we are resuming another process, resume the action it was waiting for
315 if any. Otherwise add it to the list of process to run in the next round. */
316 if (process != issuer) {
318 if (process->waiting_action) {
320 switch (process->waiting_action->type) {
322 case SIMIX_ACTION_EXECUTE:
323 case SIMIX_ACTION_PARALLEL_EXECUTE:
324 SIMIX_host_execution_resume(process->waiting_action);
327 case SIMIX_ACTION_COMMUNICATE:
328 SIMIX_comm_resume(process->waiting_action);
331 case SIMIX_ACTION_SLEEP:
332 SIMIX_process_sleep_resume(process->waiting_action);
340 xbt_swag_insert(process, simix_global->process_to_run);
345 int SIMIX_process_count(void)
347 return xbt_swag_size(simix_global->process_list);
350 void* SIMIX_process_self_get_data(void)
352 smx_process_t me = SIMIX_process_self();
356 return SIMIX_process_get_data(me);
359 void SIMIX_process_self_set_data(void *data)
361 SIMIX_process_set_data(SIMIX_process_self(), data);
364 void* SIMIX_process_get_data(smx_process_t process)
366 return process->data;
369 void SIMIX_process_set_data(smx_process_t process, void *data)
371 process->data = data;
374 smx_host_t SIMIX_process_get_host(smx_process_t process)
376 return process->smx_host;
379 /* needs to be public and without request because it is called
380 by exceptions and logging events */
381 const char* SIMIX_process_self_get_name(void) {
383 smx_process_t process = SIMIX_process_self();
384 if (process == NULL || process == simix_global->maestro_process)
387 return SIMIX_process_get_name(process);
390 const char* SIMIX_process_get_name(smx_process_t process)
392 return process->name;
395 int SIMIX_process_is_suspended(smx_process_t process)
397 return process->suspended;
400 int SIMIX_process_is_enabled(smx_process_t process)
402 if (process->request && SIMIX_request_is_enabled(process->request))
408 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
410 return process->properties;
413 void SIMIX_pre_process_sleep(smx_req_t req)
416 req->process_sleep.result = SIMIX_DONE;
417 SIMIX_request_answer(req);
419 smx_action_t action = SIMIX_process_sleep(req->issuer, req->process_sleep.duration);
420 xbt_fifo_push(action->request_list, req);
421 req->issuer->waiting_action = action;
424 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
427 smx_host_t host = process->smx_host;
429 /* check if the host is active */
430 if (surf_workstation_model->extension.
431 workstation.get_state(host->host) != SURF_RESOURCE_ON) {
432 THROW1(host_error, 0, "Host %s failed, you cannot call this function",
436 action = xbt_new0(s_smx_action_t, 1);
437 action->type = SIMIX_ACTION_SLEEP;
438 action->request_list = xbt_fifo_new();
439 action->name = xbt_strdup("sleep");
441 action->category = NULL;
444 action->sleep.host = host;
445 action->sleep.surf_sleep =
446 surf_workstation_model->extension.workstation.sleep(host->host, duration);
448 surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
449 DEBUG1("Create sleep action %p", action);
454 void SIMIX_post_process_sleep(smx_action_t action)
456 e_smx_state_t state = SIMIX_action_map_state(surf_workstation_model->action_state_get(action->sleep.surf_sleep));
459 while ((req = xbt_fifo_shift(action->request_list))) {
460 req->process_sleep.result = state;
461 req->issuer->waiting_action = NULL;
462 SIMIX_request_answer(req);
465 SIMIX_process_sleep_destroy(action);
468 void SIMIX_process_sleep_destroy(smx_action_t action)
470 DEBUG1("Destroy action %p", action);
472 xbt_free(action->name);
473 if (action->sleep.surf_sleep)
474 action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
476 TRACE_smx_action_destroy(action);
478 xbt_fifo_free(action->request_list);
482 void SIMIX_process_sleep_suspend(smx_action_t action)
484 surf_workstation_model->suspend(action->sleep.surf_sleep);
487 void SIMIX_process_sleep_resume(smx_action_t action)
489 surf_workstation_model->resume(action->sleep.surf_sleep);
493 * Calling this function makes the process to yield.
494 * Only the processes can call this function, giving back the control to maestro
496 void SIMIX_process_yield(void)
498 smx_process_t self = SIMIX_process_self();
500 DEBUG1("Yield process '%s'", self->name);
502 /* Go into sleep and return control to maestro */
503 SIMIX_context_suspend(self->context);
505 /* Ok, maestro returned control to us */
506 DEBUG1("Maestro returned control to me: '%s'", self->name);
508 if (self->context->iwannadie)
509 SIMIX_context_stop(self->context);
511 if (self->doexception) {
512 DEBUG0("Wait, maestro left me an exception");
513 self->doexception = 0;
518 /* callback: context fetching */
519 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
521 return SIMIX_process_self()->running_ctx;
524 /* callback: termination */
525 void SIMIX_process_exception_terminate(xbt_ex_t * e)
531 smx_context_t SIMIX_process_get_context(smx_process_t p) {
534 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {