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 unsigned long simix_process_maxpid = 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 XBT_DEBUG("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_maxpid++;
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);
84 maestro->request.issuer = maestro;
86 simix_global->maestro_process = maestro;
91 * \brief Same as SIMIX_process_create() but with only one argument (used by timers).
92 * \return the process created
94 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args) {
96 smx_process_t process;
97 simix_global->create_process_function(
111 * \brief Internal function to create a process.
113 * This function actually creates the process.
114 * It may be called when a REQ_PROCESS_CREATE request occurs,
115 * or directly for SIMIX internal purposes.
117 * \return the process created
119 void SIMIX_process_create(smx_process_t *process,
121 xbt_main_func_t code,
123 const char *hostname,
124 int argc, char **argv,
125 xbt_dict_t properties) {
128 smx_host_t host = SIMIX_host_get_by_name(hostname);
130 XBT_DEBUG("Start process %s on host %s", name, hostname);
132 if (!SIMIX_host_get_state(host)) {
133 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name,
137 *process = xbt_new0(s_smx_process_t, 1);
139 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
142 (*process)->pid = simix_process_maxpid++;
143 (*process)->name = xbt_strdup(name);
144 (*process)->smx_host = host;
145 (*process)->data = data;
147 XBT_VERB("Create context %s", (*process)->name);
148 (*process)->context = SIMIX_context_new(code, argc, argv,
149 simix_global->cleanup_process_function, *process);
151 (*process)->running_ctx = xbt_new(xbt_running_ctx_t, 1);
152 XBT_RUNNING_CTX_INITIALIZE((*process)->running_ctx);
155 (*process)->properties = properties;
157 /* Add the process to it's host process list */
158 xbt_swag_insert(*process, host->process_list);
160 XBT_DEBUG("Start context '%s'", (*process)->name);
162 /* Now insert it in the global process list and in the process to run list */
163 xbt_swag_insert(*process, simix_global->process_list);
164 XBT_DEBUG("Inserting %s(%s) in the to_run list", (*process)->name, host->name);
165 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, *process);
170 * \brief Internal function to kill a SIMIX process.
172 * This function may be called when a REQ_PROCESS_KILL request occurs,
173 * or directly for SIMIX internal purposes.
175 * \param process poor victim
177 void SIMIX_process_kill(smx_process_t process) {
179 XBT_DEBUG("Killing process %s on %s", process->name, process->smx_host->name);
181 process->context->iwannadie = 1;
182 process->blocked = 0;
183 process->suspended = 0;
184 /* FIXME: set doexception to 0 also? */
186 if (process->waiting_action) {
188 switch (process->waiting_action->type) {
190 case SIMIX_ACTION_EXECUTE:
191 case SIMIX_ACTION_PARALLEL_EXECUTE:
192 SIMIX_host_execution_destroy(process->waiting_action);
195 case SIMIX_ACTION_COMMUNICATE:
196 SIMIX_comm_destroy(process->waiting_action);
199 case SIMIX_ACTION_SLEEP:
200 SIMIX_process_sleep_destroy(process->waiting_action);
203 case SIMIX_ACTION_SYNCHRO:
204 SIMIX_synchro_stop_waiting(process, &process->request);
205 SIMIX_synchro_destroy(process->waiting_action);
208 case SIMIX_ACTION_IO:
214 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
218 * \brief Kills all running processes.
219 * \param issuer this one will not be killed
221 void SIMIX_process_killall(smx_process_t issuer)
223 smx_process_t p = NULL;
225 while ((p = xbt_swag_extract(simix_global->process_list))) {
227 SIMIX_process_kill(p);
231 SIMIX_context_runall(simix_global->process_to_run);
233 SIMIX_process_empty_trash();
236 void SIMIX_process_change_host(smx_process_t process,
237 const char *source, const char *dest)
239 smx_host_t h1 = NULL;
240 smx_host_t h2 = NULL;
241 xbt_assert0((process != NULL), "Invalid parameters");
242 h1 = SIMIX_host_get_by_name(source);
243 h2 = SIMIX_host_get_by_name(dest);
244 process->smx_host = h2;
245 xbt_swag_remove(process, h1->process_list);
246 xbt_swag_insert(process, h2->process_list);
249 void SIMIX_pre_process_suspend(smx_req_t req)
251 smx_process_t process = req->process_suspend.process;
252 SIMIX_process_suspend(process, req->issuer);
254 if (process != req->issuer) {
255 SIMIX_request_answer(req);
257 /* If we are suspending ourselves, then just do not replay the request. */
260 void SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
262 process->suspended = 1;
264 /* If we are suspending another process, and it is waiting on an action,
265 suspend it's action. */
266 if (process != issuer) {
268 if (process->waiting_action) {
270 switch (process->waiting_action->type) {
272 case SIMIX_ACTION_EXECUTE:
273 case SIMIX_ACTION_PARALLEL_EXECUTE:
274 SIMIX_host_execution_suspend(process->waiting_action);
277 case SIMIX_ACTION_COMMUNICATE:
278 SIMIX_comm_suspend(process->waiting_action);
281 case SIMIX_ACTION_SLEEP:
282 SIMIX_process_sleep_suspend(process->waiting_action);
292 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
294 xbt_assert0((process != NULL), "Invalid parameters");
296 process->suspended = 0;
298 /* If we are resuming another process, resume the action it was waiting for
299 if any. Otherwise add it to the list of process to run in the next round. */
300 if (process != issuer) {
302 if (process->waiting_action) {
304 switch (process->waiting_action->type) {
306 case SIMIX_ACTION_EXECUTE:
307 case SIMIX_ACTION_PARALLEL_EXECUTE:
308 SIMIX_host_execution_resume(process->waiting_action);
311 case SIMIX_ACTION_COMMUNICATE:
312 SIMIX_comm_resume(process->waiting_action);
315 case SIMIX_ACTION_SLEEP:
316 SIMIX_process_sleep_resume(process->waiting_action);
324 xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
329 int SIMIX_process_get_maxpid(void) {
330 return simix_process_maxpid;
333 int SIMIX_process_count(void)
335 return xbt_swag_size(simix_global->process_list);
338 void* SIMIX_process_self_get_data(void)
340 smx_process_t me = SIMIX_process_self();
344 return SIMIX_process_get_data(me);
347 void SIMIX_process_self_set_data(void *data)
349 SIMIX_process_set_data(SIMIX_process_self(), data);
352 void* SIMIX_process_get_data(smx_process_t process)
354 return process->data;
357 void SIMIX_process_set_data(smx_process_t process, void *data)
359 process->data = data;
362 smx_host_t SIMIX_process_get_host(smx_process_t process)
364 return process->smx_host;
367 /* needs to be public and without request because it is called
368 by exceptions and logging events */
369 const char* SIMIX_process_self_get_name(void) {
371 smx_process_t process = SIMIX_process_self();
372 if (process == NULL || process == simix_global->maestro_process)
375 return SIMIX_process_get_name(process);
378 const char* SIMIX_process_get_name(smx_process_t process)
380 return process->name;
383 smx_process_t SIMIX_process_get_by_name(const char* name)
387 xbt_swag_foreach(proc, simix_global->process_list)
389 if(!strcmp(name, proc->name))
395 int SIMIX_process_is_suspended(smx_process_t process)
397 return process->suspended;
400 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
402 return process->properties;
405 void SIMIX_pre_process_sleep(smx_req_t req)
408 MC_process_clock_add(req->issuer, req->process_sleep.duration);
409 req->process_sleep.result = SIMIX_DONE;
410 SIMIX_request_answer(req);
413 smx_action_t action = SIMIX_process_sleep(req->issuer, req->process_sleep.duration);
414 xbt_fifo_push(action->request_list, req);
415 req->issuer->waiting_action = action;
418 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
421 smx_host_t host = process->smx_host;
423 /* check if the host is active */
424 if (surf_workstation_model->extension.
425 workstation.get_state(host->host) != SURF_RESOURCE_ON) {
426 THROW1(host_error, 0, "Host %s failed, you cannot call this function",
430 action = xbt_mallocator_get(simix_global->action_mallocator);
431 action->type = SIMIX_ACTION_SLEEP;
434 action->category = NULL;
437 action->sleep.host = host;
438 action->sleep.surf_sleep =
439 surf_workstation_model->extension.workstation.sleep(host->host, duration);
441 surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
442 XBT_DEBUG("Create sleep action %p", action);
447 void SIMIX_post_process_sleep(smx_action_t action)
452 while ((req = xbt_fifo_shift(action->request_list))) {
454 switch(surf_workstation_model->action_state_get(action->sleep.surf_sleep)){
455 case SURF_ACTION_FAILED:
456 state = SIMIX_SRC_HOST_FAILURE;
459 case SURF_ACTION_DONE:
467 req->process_sleep.result = state;
468 req->issuer->waiting_action = NULL;
469 SIMIX_request_answer(req);
471 SIMIX_process_sleep_destroy(action);
474 void SIMIX_process_sleep_destroy(smx_action_t action)
476 XBT_DEBUG("Destroy action %p", action);
477 if (action->sleep.surf_sleep)
478 action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
480 TRACE_smx_action_destroy(action);
482 xbt_mallocator_release(simix_global->action_mallocator, action);
485 void SIMIX_process_sleep_suspend(smx_action_t action)
487 surf_workstation_model->suspend(action->sleep.surf_sleep);
490 void SIMIX_process_sleep_resume(smx_action_t action)
492 surf_workstation_model->resume(action->sleep.surf_sleep);
496 * Calling this function makes the process to yield.
497 * Only the processes can call this function, giving back the control to maestro
499 void SIMIX_process_yield(void)
501 smx_process_t self = SIMIX_process_self();
503 XBT_DEBUG("Yield process '%s'", self->name);
505 /* Go into sleep and return control to maestro */
506 SIMIX_context_suspend(self->context);
508 /* Ok, maestro returned control to us */
509 XBT_DEBUG("Maestro returned control to me: '%s'", self->name);
511 if (self->context->iwannadie){
512 XBT_DEBUG("I wanna die!");
513 SIMIX_context_stop(self->context);
516 if (self->doexception) {
517 XBT_DEBUG("Wait, maestro left me an exception");
518 self->doexception = 0;
523 /* callback: context fetching */
524 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
526 return SIMIX_process_self()->running_ctx;
529 /* callback: termination */
530 void SIMIX_process_exception_terminate(xbt_ex_t * e)
536 smx_context_t SIMIX_process_get_context(smx_process_t p) {
540 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {