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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
14 "Logging specific to SIMIX (process)");
17 * \brief Move a process to the list of process to destroy. *
19 void SIMIX_process_cleanup(void *arg)
21 xbt_swag_remove(arg, simix_global->process_to_run);
22 xbt_swag_remove(arg, simix_global->process_list);
23 xbt_swag_remove(arg, ((smx_process_t) arg)->smx_host->process_list);
24 xbt_swag_insert(arg, simix_global->process_to_destroy);
30 * Should be called some time to time to free the memory allocated for processes
31 * that have finished (or killed).
33 void SIMIX_process_empty_trash(void)
35 smx_process_t process = NULL;
37 while ((process = xbt_swag_extract(simix_global->process_to_destroy))) {
38 SIMIX_context_free(process->context);
40 /* Free the exception allocated at creation time */
41 if (process->exception)
42 free(process->exception);
43 if (process->properties)
44 xbt_dict_free(&process->properties);
53 * \brief Creates and runs the maestro process
55 void SIMIX_create_maestro_process()
57 smx_process_t process = NULL;
58 process = xbt_new0(s_smx_process_t, 1);
61 process->name = (char *) "";
63 process->exception = xbt_new(ex_ctx_t, 1);
64 XBT_CTX_INITIALIZE(process->exception);
66 /* Create a dummy context for maestro */
67 process->context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL);
69 /* Set it as the maestro process */
70 simix_global->maestro_process = process;
71 simix_global->current_process = process;
77 * \brief Creates and runs a new #smx_process_t.
79 * A constructor for #m_process_t taking four arguments and returning the corresponding object. The structure (and the corresponding thread) is created, and put in the list of ready process.
81 * \param name a name for the object. It is for user-level information and can be NULL.
82 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can be NULL. It can be retrieved with the function \ref MSG_process_get_data.
83 * \param host the location where the new agent is executed.
84 * \param argc first argument passed to \a code
85 * \param argv second argument passed to \a code
86 * \param clean_process_function The cleanup function of user process. It will be called when the process finish. This function have to call the SIMIX_process_cleanup.
88 * \return The new corresponding object.
90 smx_process_t SIMIX_process_create(const char *name,
91 xbt_main_func_t code, void *data,
92 const char *hostname, int argc,
93 char **argv, xbt_dict_t properties)
95 smx_process_t process = NULL;
96 smx_host_t host = SIMIX_host_get_by_name(hostname);
98 DEBUG2("Start process %s on host %s", name, hostname);
100 if (!SIMIX_host_get_state(host)) {
101 WARN2("Cannot launch process '%s' on failed host '%s'", name,
105 process = xbt_new0(s_smx_process_t, 1);
107 xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
110 process->name = xbt_strdup(name);
111 process->smx_host = host;
112 process->mutex = NULL;
113 process->cond = NULL;
114 process->iwannadie = 0;
115 process->data = data;
117 VERB1("Create context %s", process->name);
118 process->context = SIMIX_context_new(code, argc, argv,
119 simix_global->cleanup_process_function,
122 process->exception = xbt_new(ex_ctx_t, 1);
123 XBT_CTX_INITIALIZE(process->exception);
126 process->properties = properties;
128 /* Add the process to it's host process list */
129 xbt_swag_insert(process, host->process_list);
131 DEBUG1("Start context '%s'", process->name);
133 /* Now insert it in the global process list and in the process to run list */
134 xbt_swag_insert(process, simix_global->process_list);
135 DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
136 xbt_swag_insert(process, simix_global->process_to_run);
141 /** \brief Kill a SIMIX process
143 * This function simply kills a \a process... scarry isn't it ? :).
144 * \param process poor victim
147 void SIMIX_process_kill(smx_process_t process)
149 DEBUG2("Killing process %s on %s", process->name,
150 process->smx_host->name);
152 process->iwannadie = 1;
154 /* If I'm killing myself then stop otherwise schedule the process to kill
155 * Two different behaviors, if I'm killing my self, remove from mutex and condition and stop. Otherwise, first we must schedule the process, wait its ending and after remove it from mutex and condition */
156 if (process == SIMIX_process_self()) {
157 /* Cleanup if we were waiting for something */
159 xbt_swag_remove(process, process->mutex->sleeping);
162 xbt_swag_remove(process, process->cond->sleeping);
163 if (process->waiting_action) {
164 SIMIX_unregister_action_to_condition(process->waiting_action,
166 SIMIX_action_destroy(process->waiting_action);
170 xbt_fifo_remove(process->sem->sleeping, process);
172 if (process->waiting_action) {
173 SIMIX_unregister_action_to_semaphore(process->waiting_action,
175 SIMIX_action_destroy(process->waiting_action);
179 SIMIX_context_stop(process->context);
182 DEBUG4("%s(%p) here! killing %s(%p)",
183 simix_global->current_process->name,
184 simix_global->current_process, process->name, process);
186 /* Cleanup if it were waiting for something */
187 if (process->mutex) {
188 xbt_swag_remove(process, process->mutex->sleeping);
189 process->mutex = NULL;
193 xbt_swag_remove(process, process->cond->sleeping);
195 if (process->waiting_action) {
196 SIMIX_unregister_action_to_condition(process->waiting_action,
198 SIMIX_action_destroy(process->waiting_action);
200 process->cond = NULL;
204 xbt_fifo_remove(process->sem->sleeping, process);
206 if (process->waiting_action) {
207 SIMIX_unregister_action_to_semaphore(process->waiting_action,
209 SIMIX_action_destroy(process->waiting_action);
214 /* make sure that the process gets awake soon enough, now that we've set its iwannadie to 1 */
215 process->blocked = 0;
216 process->suspended = 0;
217 xbt_swag_insert(process, simix_global->process_to_run);
222 * \brief Return the user data of a #smx_process_t.
224 * This functions checks whether \a process is a valid pointer or not and return the user data associated to \a process if it is possible.
225 * \param process SIMIX process
226 * \return A void pointer to the user data
228 XBT_INLINE void *SIMIX_process_get_data(smx_process_t process)
230 xbt_assert0((process != NULL), "Invalid parameters");
231 return (process->data);
235 * \brief Set the user data of a #m_process_t.
237 * This functions checks whether \a process is a valid pointer or not and set the user data associated to \a process if it is possible.
238 * \param process SIMIX process
239 * \param data User data
241 XBT_INLINE void SIMIX_process_set_data(smx_process_t process, void *data)
243 xbt_assert0((process != NULL), "Invalid parameters");
245 process->data = data;
250 * \brief Return the location on which an agent is running.
252 * This functions checks whether \a process is a valid pointer or not and return the m_host_t corresponding to the location on which \a process is running.
253 * \param process SIMIX process
256 XBT_INLINE smx_host_t SIMIX_process_get_host(smx_process_t process)
258 xbt_assert0((process != NULL), "Invalid parameters");
259 return (process->smx_host);
263 * \brief Return the name of an agent.
265 * This functions checks whether \a process is a valid pointer or not and return its name.
266 * \param process SIMIX process
267 * \return The process name
269 XBT_INLINE const char *SIMIX_process_get_name(smx_process_t process)
271 xbt_assert0((process != NULL), "Invalid parameters");
272 return (process->name);
276 * \brief Changes the name of an agent.
278 * This functions checks whether \a process is a valid pointer or not and return its name.
279 * \param process SIMIX process
280 * \param name The new process name
282 XBT_INLINE void SIMIX_process_set_name(smx_process_t process, char *name)
284 xbt_assert0((process != NULL), "Invalid parameters");
285 process->name = name;
288 /** \ingroup m_process_management
289 * \brief Return the properties
291 * This functions returns the properties associated with this process
293 XBT_INLINE xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
295 return process->properties;
299 * \brief Return the current agent.
301 * This functions returns the currently running #smx_process_t.
302 * \return The SIMIX process
304 XBT_INLINE smx_process_t SIMIX_process_self(void)
307 return simix_global->current_process;
312 * \brief Suspend the process.
314 * This functions suspend the process by suspending the action on
315 * which it was waiting for the completion.
317 * \param process SIMIX process
319 void SIMIX_process_suspend(smx_process_t process)
321 xbt_assert0(process, "Invalid parameters");
323 if (process != SIMIX_process_self()) {
325 if (process->mutex) {
326 /* process blocked on a mutex or sem, only set suspend=1 */
327 process->suspended = 1;
328 } else if (process->cond) {
329 /* process blocked cond, suspend all actions */
331 /* temporaries variables */
336 process->suspended = 1;
338 xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
339 SIMIX_action_suspend(act);
341 } else if (process->sem) {
346 process->suspended = 1;
348 xbt_fifo_foreach(s->actions, i, act, smx_action_t) {
349 SIMIX_action_suspend(act);
352 process->suspended = 1;
355 /* process executing, I can create an action and suspend it */
358 char name[] = "dummy";
359 process->suspended = 1;
361 cond = SIMIX_cond_init();
362 dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
363 SIMIX_process_self()->waiting_action = dummy;
364 SIMIX_action_suspend(dummy);
365 SIMIX_register_action_to_condition(dummy, cond);
366 __SIMIX_cond_wait(cond);
367 SIMIX_process_self()->waiting_action = NULL;
368 SIMIX_unregister_action_to_condition(dummy, cond);
369 SIMIX_action_destroy(dummy);
370 SIMIX_cond_destroy(cond);
376 * \brief Resume a suspended process.
378 * This functions resume a suspended process by resuming the task on which it was waiting for the completion.
379 * \param process SIMIX process
381 void SIMIX_process_resume(smx_process_t process)
383 xbt_assert0((process != NULL), "Invalid parameters");
386 if (process == SIMIX_process_self())
389 if (process->mutex) {
390 DEBUG0("Resume process blocked on a mutex or semaphore");
391 process->suspended = 0; /* It'll wake up by itself when mutex releases */
393 } else if (process->cond) {
394 /* temporaries variables */
398 DEBUG0("Resume process blocked on a conditional");
399 process->suspended = 0;
401 xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
402 SIMIX_action_resume(act);
404 SIMIX_cond_signal(c);
406 } else if (process->sem) {
407 /* temporaries variables */
411 DEBUG0("Resume process blocked on a semaphore");
412 process->suspended = 0;
414 xbt_fifo_foreach(s->actions, i, act, smx_action_t) {
415 SIMIX_action_resume(act);
419 process->suspended = 0;
420 xbt_swag_insert(process, simix_global->process_to_run);
425 * \brief Migrates an agent to another location.
427 * This function changes the value of the host on which \a process is running.
429 void SIMIX_process_change_host(smx_process_t process, char *source,
432 smx_host_t h1 = NULL;
433 smx_host_t h2 = NULL;
434 xbt_assert0((process != NULL), "Invalid parameters");
435 h1 = SIMIX_host_get_by_name(source);
436 h2 = SIMIX_host_get_by_name(dest);
437 process->smx_host = h2;
438 xbt_swag_remove(process, h1->process_list);
439 xbt_swag_insert(process, h2->process_list);
443 * \brief Returns true if the process is suspended .
445 * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
446 * \param process SIMIX process
447 * \return 1, if the process is suspended, else 0.
449 XBT_INLINE int SIMIX_process_is_suspended(smx_process_t process)
451 xbt_assert0((process != NULL), "Invalid parameters");
453 return (process->suspended);
457 * \brief Returns the amount of SIMIX processes in the system
459 * Maestro internal process is not counted, only user code processes are
461 XBT_INLINE int SIMIX_process_count()
463 return xbt_swag_size(simix_global->process_list);
467 * Calling this function makes the process process to yield. The process
468 * that scheduled it returns from __SIMIX_process_schedule as if nothing
471 * Only the processes can call this function, giving back the control
474 void SIMIX_process_yield(void)
476 DEBUG1("Yield process '%s'", simix_global->current_process->name);
477 xbt_assert0((simix_global->current_process !=
478 simix_global->maestro_process),
479 "You are not supposed to run this function in maestro context!");
482 /* Go into sleep and return control to maestro */
483 SIMIX_context_suspend(simix_global->current_process->context);
484 /* Ok, maestro returned control to us */
486 if (simix_global->current_process->iwannadie)
487 SIMIX_context_stop(simix_global->current_process->context);
490 void SIMIX_process_schedule(smx_process_t new_process)
492 xbt_assert0(simix_global->current_process ==
493 simix_global->maestro_process,
494 "This function can only be called from maestro context");
495 DEBUG1("Scheduling context: '%s'", new_process->name);
497 /* update the current process */
498 simix_global->current_process = new_process;
500 /* schedule the context */
501 SIMIX_context_resume(new_process->context);
502 DEBUG1("Resumed from scheduling context: '%s'", new_process->name);
504 /* restore the current process to the previously saved process */
505 simix_global->current_process = simix_global->maestro_process;
508 /* callback: context fetching */
509 ex_ctx_t *SIMIX_process_get_exception(void)
511 return simix_global->current_process->exception;
514 /* callback: termination */
515 void SIMIX_process_exception_terminate(xbt_ex_t * e)