-//* $Id$ */
-
-/* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */
+/* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#include "private.h"
#include "xbt/sysdep.h"
#include "xbt/log.h"
+#include "xbt/dict.h"
+#include "msg/mailbox.h"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
- "Logging specific to SIMIX (process)");
+ "Logging specific to SIMIX (process)");
-/******************************** Process ************************************/
/**
- * \brief Creates and runs a new #smx_process_t.
- *
- * Does exactly the same as #SIMIX_process_create_with_arguments but without
- providing standard arguments (\a argc, \a argv).
- * \see SIMIX_process_create_with_arguments
+ * \brief Move a process to the list of process to destroy. *
*/
-
-
void SIMIX_process_cleanup(void *arg)
{
- xbt_swag_remove(arg, simix_global->process_list);
xbt_swag_remove(arg, simix_global->process_to_run);
- xbt_swag_remove(arg,
- ((smx_process_t) arg)->simdata->s_host->simdata->
- process_list);
- free(((smx_process_t) arg)->name);
- ((smx_process_t) arg)->name = NULL;
-
- free(((smx_process_t) arg)->simdata);
- ((smx_process_t) arg)->simdata = NULL;
- free(arg);
+ xbt_swag_remove(arg, simix_global->process_list);
+ xbt_swag_remove(arg, ((smx_process_t) arg)->smx_host->process_list);
+ xbt_swag_insert(arg, simix_global->process_to_destroy);
}
/**
+ * Garbage collection
+ *
+ * Should be called some time to time to free the memory allocated for processes
+ * that have finished (or killed).
+ */
+void SIMIX_process_empty_trash(void)
+{
+ smx_process_t process = NULL;
+
+ while ((process = xbt_swag_extract(simix_global->process_to_destroy))) {
+ SIMIX_context_free(process->context);
+
+ /* Free the exception allocated at creation time */
+ if (process->exception)
+ free(process->exception);
+ if (process->properties)
+ xbt_dict_free(&process->properties);
+
+ free(process->name);
+ process->name = NULL;
+ free(process);
+ }
+}
+
+/**
+ * \brief Creates and runs the maestro process
+ */
+void SIMIX_create_maestro_process()
+{
+ smx_process_t process = NULL;
+ process = xbt_new0(s_smx_process_t, 1);
+
+ /* Process data */
+ process->name = (char *) "";
+
+ process->exception = xbt_new(ex_ctx_t, 1);
+ XBT_CTX_INITIALIZE(process->exception);
+
+ /* Create a dummy context for maestro */
+ process->context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL);
+
+ /* Set it as the maestro process */
+ simix_global->maestro_process = process;
+ simix_global->current_process = process;
+
+ return;
+}
+
+/**
* \brief Creates and runs a new #smx_process_t.
*
* 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.
*
* \param name a name for the object. It is for user-level information and can be NULL.
-* \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.
+ * \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.
* \param host the location where the new agent is executed.
* \param argc first argument passed to \a code
* \param argv second argument passed to \a code
- * \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.
+ * \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.
* \see smx_process_t
* \return The new corresponding object.
*/
smx_process_t SIMIX_process_create(const char *name,
- xbt_main_func_t code, void *data,
- const char *hostname, int argc,
- char **argv)
+ xbt_main_func_t code, void *data,
+ const char *hostname, int argc,
+ char **argv, xbt_dict_t properties)
{
- smx_simdata_process_t simdata = xbt_new0(s_smx_simdata_process_t, 1);
- smx_process_t process = xbt_new0(s_smx_process_t, 1);
- smx_process_t self = NULL;
+ smx_process_t process = NULL;
smx_host_t host = SIMIX_host_get_by_name(hostname);
+ DEBUG2("Start process %s on host %s", name, hostname);
+
+ if (!SIMIX_host_get_state(host)) {
+ WARN2("Cannot launch process '%s' on failed host '%s'", name, hostname);
+ return NULL;
+ }
+ process = xbt_new0(s_smx_process_t, 1);
+
xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
- /* Simulator Data */
-
- simdata->s_host = host;
- simdata->mutex = NULL;
- simdata->cond = NULL;
- simdata->argc = argc;
- simdata->argv = argv;
- simdata->context = xbt_context_new(name,code, NULL, NULL,
- simix_global->
- cleanup_process_function, process,
- simdata->argc, simdata->argv);
-
- /* Process structure */
+
+ /* Process data */
process->name = xbt_strdup(name);
- process->simdata = simdata;
+ process->smx_host = host;
+ process->mutex = NULL;
+ process->cond = NULL;
+ process->iwannadie = 0;
process->data = data;
- xbt_swag_insert(process, host->simdata->process_list);
-
- /* fix current_process, about which xbt_context_start mocks around */
- self = simix_global->current_process;
- xbt_context_start(process->simdata->context);
- simix_global->current_process = self;
-
- xbt_swag_insert(process, simix_global->process_list);
- DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
- xbt_swag_insert(process, simix_global->process_to_run);
+ VERB1("Create context %s", process->name);
+ process->context = SIMIX_context_new(code, argc, argv,
+ simix_global->cleanup_process_function,
+ process);
- return process;
-}
+ process->exception = xbt_new(ex_ctx_t, 1);
+ XBT_CTX_INITIALIZE(process->exception);
-/**
- * \brief Creates and runs a new #smx_process_t hosting a JAVA thread
- *
- * Warning: this should only be used in libsimgrid4java, since it create
- * a context with no code, which leads to segfaults in plain libsimgrid
- */
-void SIMIX_jprocess_create(const char *name, smx_host_t host,
- void *data,
- void *jprocess, void *jenv, smx_process_t * res)
-{
- smx_simdata_process_t simdata = xbt_new0(s_smx_simdata_process_t, 1);
- smx_process_t process = xbt_new0(s_smx_process_t, 1);
- smx_process_t self = NULL;
-
- /* HACK: We need this trick because when we xbt_context_new() do
- syncronization stuff, the s_process field in the m_process needs
- to have a valid value, and we call xbt_context_new() before
- returning, of course, ie, before providing a right value to the
- caller (Java_simgrid_msg_Msg_processCreate) have time to store it
- in place. This way, we initialize the m_process->simdata->s_process
- field ourself ASAP.
-
- All this would be much simpler if the synchronization stuff would be done
- in the JAVA world, I think.
- */
- *res = process;
-
-
-
- DEBUG5("jprocess_create(name=%s,host=%p,data=%p,jproc=%p,jenv=%p)",
- name, host, data, jprocess, jenv);
- xbt_assert0(host, "Invalid parameters");
- /* Simulator Data */
- simdata->s_host = host;
- simdata->mutex = NULL;
- simdata->cond = NULL;
- simdata->argc = 0;
- simdata->argv = NULL;
-
- simdata->context = xbt_context_new(name,NULL, NULL, NULL,
- simix_global->
- cleanup_process_function, process,
- /* argc/argv */ 0, NULL);
-
- /* Process structure */
- process->name = xbt_strdup(name);
- process->simdata = simdata;
- process->data = data;
- SIMIX_process_set_jprocess(process, jprocess);
- SIMIX_process_set_jenv(process, jenv);
+ /* Add properties */
+ process->properties = properties;
- xbt_swag_insert(process, host->simdata->process_list);
+ /* Add the process to it's host process list */
+ xbt_swag_insert(process, host->process_list);
- /* fix current_process, about which xbt_context_start mocks around */
- self = simix_global->current_process;
- xbt_context_start(process->simdata->context);
- simix_global->current_process = self;
+ DEBUG1("Start context '%s'", process->name);
+ /* Now insert it in the global process list and in the process to run list */
xbt_swag_insert(process, simix_global->process_list);
DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
xbt_swag_insert(process, simix_global->process_to_run);
+ return process;
}
-
/** \brief Kill a SIMIX process
*
* This function simply kills a \a process... scarry isn't it ? :).
*/
void SIMIX_process_kill(smx_process_t process)
{
- smx_simdata_process_t p_simdata = process->simdata;
+ DEBUG2("Killing process %s on %s", process->name, process->smx_host->name);
- DEBUG2("Killing process %s on %s", process->name,
- p_simdata->s_host->name);
+ process->iwannadie = 1;
- /* Cleanup if we were waiting for something */
- if (p_simdata->mutex)
- xbt_swag_remove(process, p_simdata->mutex->sleeping);
+ /* If I'm killing myself then stop otherwise schedule the process to kill
+ * 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 */
+ if (process == SIMIX_process_self()) {
+ /* Cleanup if we were waiting for something */
+ if (process->mutex)
+ xbt_swag_remove(process, process->mutex->sleeping);
+
+ if (process->cond)
+ xbt_swag_remove(process, process->cond->sleeping);
+ if (process->waiting_action) {
+ SIMIX_unregister_action_to_condition(process->waiting_action, process->cond);
+ SIMIX_action_destroy(process->waiting_action);
+ }
- if (p_simdata->cond)
- xbt_swag_remove(process, p_simdata->cond->sleeping);
+ if (process->sem) {
+ xbt_fifo_remove(process->sem->sleeping, process);
+
+ if (process->waiting_action) {
+ SIMIX_unregister_action_to_semaphore(process->waiting_action, process->sem);
+ SIMIX_action_destroy(process->waiting_action);
+ }
+ }
- xbt_swag_remove(process, simix_global->process_to_run);
- xbt_swag_remove(process, simix_global->process_list);
- DEBUG2("%p here! killing %p", simix_global->current_process, process);
- xbt_context_kill(process->simdata->context);
+ SIMIX_context_stop(process->context);
- if (process == SIMIX_process_self()) {
- /* I just killed myself */
- xbt_context_yield();
+ } else {
+ DEBUG4("%s(%p) here! killing %s(%p)",
+ simix_global->current_process->name,simix_global->current_process,
+ process->name,process);
+
+ /* Cleanup if it were waiting for something */
+ if (process->mutex) {
+ xbt_swag_remove(process, process->mutex->sleeping);
+ process->mutex = NULL;
+ }
+
+ if (process->cond) {
+ xbt_swag_remove(process, process->cond->sleeping);
+
+ if (process->waiting_action) {
+ SIMIX_unregister_action_to_condition(process->waiting_action, process->cond);
+ SIMIX_action_destroy(process->waiting_action);
+ }
+ process->cond = NULL;
+ }
+
+ if (process->sem) {
+ xbt_fifo_remove(process->sem->sleeping, process);
+
+ if (process->waiting_action) {
+ SIMIX_unregister_action_to_semaphore(process->waiting_action, process->sem);
+ SIMIX_action_destroy(process->waiting_action);
+ }
+ process->sem = NULL;
+ }
+
+ /* make sure that the process gets awake soon enough, now that we've set its iwannadie to 1 */
+ process->blocked = 0;
+ process->suspended = 0;
+ xbt_swag_insert(process, simix_global->process_to_run);
}
}
* \param process SIMIX process
* \return A void pointer to the user data
*/
-void *SIMIX_process_get_data(smx_process_t process)
+XBT_INLINE void *SIMIX_process_get_data(smx_process_t process)
{
xbt_assert0((process != NULL), "Invalid parameters");
-
return (process->data);
}
* \param process SIMIX process
* \param data User data
*/
-void SIMIX_process_set_data(smx_process_t process, void *data)
+XBT_INLINE void SIMIX_process_set_data(smx_process_t process, void *data)
{
xbt_assert0((process != NULL), "Invalid parameters");
- //xbt_assert0((process->data == NULL), "Data already set");
process->data = data;
-
return;
}
* \param process SIMIX process
* \return SIMIX host
*/
-smx_host_t SIMIX_process_get_host(smx_process_t process)
+XBT_INLINE smx_host_t SIMIX_process_get_host(smx_process_t process)
{
- xbt_assert0(((process != NULL)
- && (process->simdata)), "Invalid parameters");
-
- return (process->simdata->s_host);
+ xbt_assert0((process != NULL), "Invalid parameters");
+ return (process->smx_host);
}
/**
* \param process SIMIX process
* \return The process name
*/
-const char *SIMIX_process_get_name(smx_process_t process)
+XBT_INLINE const char *SIMIX_process_get_name(smx_process_t process)
{
- xbt_assert0(((process != NULL)
- && (process->simdata)), "Invalid parameters");
-
+ xbt_assert0((process != NULL), "Invalid parameters");
return (process->name);
}
+/**
+ * \brief Changes the name of an agent.
+ *
+ * This functions checks whether \a process is a valid pointer or not and return its name.
+ * \param process SIMIX process
+ * \param name The new process name
+ */
+XBT_INLINE void SIMIX_process_set_name(smx_process_t process, char *name)
+{
+ xbt_assert0((process != NULL), "Invalid parameters");
+ process->name = name;
+}
+
+/** \ingroup m_process_management
+ * \brief Return the properties
+ *
+ * This functions returns the properties associated with this process
+ */
+XBT_INLINE xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
+{
+ return process->properties;
+}
+
/**
* \brief Return the current agent.
*
* This functions returns the currently running #smx_process_t.
* \return The SIMIX process
*/
-smx_process_t SIMIX_process_self(void)
+XBT_INLINE smx_process_t SIMIX_process_self(void)
{
- return simix_global ? simix_global->current_process : NULL;
+ if(simix_global)
+ return simix_global->current_process;
+ return NULL;
}
/**
*/
void SIMIX_process_suspend(smx_process_t process)
{
- smx_simdata_process_t simdata = NULL;
-
- xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
+ xbt_assert0(process, "Invalid parameters");
if (process != SIMIX_process_self()) {
- simdata = process->simdata;
- if (simdata->mutex) {
- /* process blocked on a mutex, only set suspend=1 */
- simdata->suspended = 1;
- } else if (simdata->cond) {
+ if (process->mutex) {
+ /* process blocked on a mutex or sem, only set suspend=1 */
+ process->suspended = 1;
+ } else if (process->cond) {
/* process blocked cond, suspend all actions */
/* temporaries variables */
xbt_fifo_item_t i;
smx_action_t act;
- simdata->suspended = 1;
- c = simdata->cond;
+ process->suspended = 1;
+ c = process->cond;
xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
- surf_workstation_resource->common_public->suspend(act->simdata->
- surf_action);
+ SIMIX_action_suspend(act);
+ }
+ } else if (process->sem) {
+ smx_sem_t s;
+ xbt_fifo_item_t i;
+ smx_action_t act;
+
+ process->suspended = 1;
+ s = process->sem;
+ xbt_fifo_foreach(s->actions, i, act, smx_action_t) {
+ SIMIX_action_suspend(act);
}
} else {
- simdata->suspended = 1;
+ process->suspended = 1;
}
} else {
/* process executing, I can create an action and suspend it */
- process->simdata->suspended = 1;
smx_action_t dummy;
smx_cond_t cond;
char name[] = "dummy";
+ process->suspended = 1;
cond = SIMIX_cond_init();
dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
- surf_workstation_resource->common_public->set_priority(dummy->simdata->
- surf_action,
- 0.0);
+ SIMIX_process_self()->waiting_action = dummy;
+ SIMIX_action_suspend(dummy);
SIMIX_register_action_to_condition(dummy, cond);
__SIMIX_cond_wait(cond);
- //SIMIX_action_destroy(dummy);
- //SIMIX_cond_destroy(cond);
+ SIMIX_process_self()->waiting_action = NULL;
+ SIMIX_unregister_action_to_condition(dummy, cond);
+ SIMIX_action_destroy(dummy);
+ SIMIX_cond_destroy(cond);
}
return;
}
*/
void SIMIX_process_resume(smx_process_t process)
{
- smx_simdata_process_t simdata = NULL;
-
- xbt_assert0(((process != NULL)
- && (process->simdata)), "Invalid parameters");
+ xbt_assert0((process != NULL), "Invalid parameters");
SIMIX_CHECK_HOST();
- if (process == SIMIX_process_self()) {
+ if (process == SIMIX_process_self())
return;
- }
- simdata = process->simdata;
- if (simdata->mutex) {
- DEBUG0("Resume process blocked on a mutex");
- simdata->suspended = 0; /* He'll wake up by itself */
+ if (process->mutex) {
+ DEBUG0("Resume process blocked on a mutex or semaphore");
+ process->suspended = 0; /* It'll wake up by itself when mutex releases */
return;
- } else if (simdata->cond) {
- DEBUG0("Resume process blocked on a conditional");
+ } else if (process->cond) {
/* temporaries variables */
smx_cond_t c;
xbt_fifo_item_t i;
smx_action_t act;
- simdata->suspended = 0;
- c = simdata->cond;
+ DEBUG0("Resume process blocked on a conditional");
+ process->suspended = 0;
+ c = process->cond;
xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
- surf_workstation_resource->common_public->resume(act->simdata->
- surf_action);
+ SIMIX_action_resume(act);
+ }
+ SIMIX_cond_signal(c);
+ return;
+ } else if (process->sem) {
+ /* temporaries variables */
+ smx_sem_t s;
+ xbt_fifo_item_t i;
+ smx_action_t act;
+ DEBUG0("Resume process blocked on a semaphore");
+ process->suspended = 0;
+ s = process->sem;
+ xbt_fifo_foreach(s->actions, i, act, smx_action_t) {
+ SIMIX_action_resume(act);
}
return;
} else {
- simdata->suspended = 0;
+ process->suspended = 0;
xbt_swag_insert(process, simix_global->process_to_run);
}
+}
+/**
+ * \brief Migrates an agent to another location.
+ *
+ * This function changes the value of the host on which \a process is running.
+ */
+void SIMIX_process_change_host(smx_process_t process, char *source,
+ char *dest)
+{
+ smx_host_t h1 = NULL;
+ smx_host_t h2 = NULL;
+ xbt_assert0((process != NULL), "Invalid parameters");
+ h1 = SIMIX_host_get_by_name(source);
+ h2 = SIMIX_host_get_by_name(dest);
+ process->smx_host = h2;
+ xbt_swag_remove(process, h1->process_list);
+ xbt_swag_insert(process, h2->process_list);
}
/**
* \param process SIMIX process
* \return 1, if the process is suspended, else 0.
*/
-int SIMIX_process_is_suspended(smx_process_t process)
+XBT_INLINE int SIMIX_process_is_suspended(smx_process_t process)
{
- xbt_assert0(((process != NULL)
- && (process->simdata)), "Invalid parameters");
+ xbt_assert0((process != NULL), "Invalid parameters");
- return (process->simdata->suspended);
+ return (process->suspended);
}
-
-/* Helper functions for jMSG: manipulate the context data without breaking the module separation */
-#include "xbt/context.h" /* to pass java objects from MSG to the context */
-
-void SIMIX_process_set_jprocess(smx_process_t process, void *jp)
+/**
+ * \brief Returns the amount of SIMIX processes in the system
+ *
+ * Maestro internal process is not counted, only user code processes are
+ */
+XBT_INLINE int SIMIX_process_count()
{
- xbt_context_set_jprocess(process->simdata->context, jp);
+ return xbt_swag_size(simix_global->process_list);
}
-void *SIMIX_process_get_jprocess(smx_process_t process)
+/**
+ * Calling this function makes the process process to yield. The process
+ * that scheduled it returns from __SIMIX_process_schedule as if nothing
+ * had happened.
+ *
+ * Only the processes can call this function, giving back the control
+ * to the maestro
+ */
+void SIMIX_process_yield(void)
{
- return xbt_context_get_jprocess(process->simdata->context);
-}
+ DEBUG1("Yield process '%s'", simix_global->current_process->name);
+ xbt_assert0((simix_global->current_process !=
+ simix_global->maestro_process),
+ "You are not supposed to run this function in maestro context!");
-void SIMIX_process_set_jmutex(smx_process_t process, void *jm)
-{
- xbt_context_set_jmutex(process->simdata->context, jm);
-}
-void *SIMIX_process_get_jmutex(smx_process_t process)
-{
- return xbt_context_get_jmutex(process->simdata->context);
-}
+ /* Go into sleep and return control to maestro */
+ SIMIX_context_suspend(simix_global->current_process->context);
+ /* Ok, maestro returned control to us */
-void SIMIX_process_set_jcond(smx_process_t process, void *jc)
-{
- xbt_context_set_jcond(process->simdata->context, jc);
+ if (simix_global->current_process->iwannadie)
+ SIMIX_context_stop(simix_global->current_process->context);
}
-void *SIMIX_process_get_jcond(smx_process_t process)
+void SIMIX_process_schedule(smx_process_t new_process)
{
- return xbt_context_get_jcond(process->simdata->context);
+ xbt_assert0(simix_global->current_process == simix_global->maestro_process,
+ "This function can only be called from maestro context");
+ DEBUG1("Scheduling context: '%s'", new_process->name);
+
+ /* update the current process */
+ simix_global->current_process = new_process;
+
+ /* schedule the context */
+ SIMIX_context_resume(new_process->context);
+ DEBUG1("Resumed from scheduling context: '%s'", new_process->name);
+
+ /* restore the current process to the previously saved process */
+ simix_global->current_process = simix_global->maestro_process;
}
-void SIMIX_process_set_jenv(smx_process_t process, void *je)
+/* callback: context fetching */
+ex_ctx_t *SIMIX_process_get_exception(void)
{
- xbt_context_set_jenv(process->simdata->context, je);
+ return simix_global->current_process->exception;
}
-void *SIMIX_process_get_jenv(smx_process_t process)
+/* callback: termination */
+void SIMIX_process_exception_terminate(xbt_ex_t * e)
{
- return xbt_context_get_jenv(process->simdata->context);
+ xbt_ex_display(e);
+ abort();
}
