Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Initialize the process data in MSG before actually creating it,
[simgrid.git] / src / msg / m_process.c
index 900f4cb..0084efd 100644 (file)
@@ -1,8 +1,5 @@
-/*     $Id$      */
-
-/* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
-/* Copyright (c) 2007 Bruno Donassolo.                                      */
-/* All rights reserved.                                                     */
+/* Copyright (c) 2004, 2005, 2006, 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. */
@@ -12,7 +9,7 @@
 #include "xbt/log.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
-                               "Logging specific to MSG (process)");
+                                "Logging specific to MSG (process)");
 
 /** \defgroup m_process_management Management Functions of Agents
  *  \brief This section describes the agent structure of MSG
@@ -20,7 +17,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
  */
 /** @addtogroup m_process_management
  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
- * 
+ *
  *  We need to simulate many independent scheduling decisions, so
  *  the concept of <em>process</em> is at the heart of the
  *  simulator. A process may be defined as a <em>code</em>, with
@@ -29,16 +26,23 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
  */
 
 /******************************** Process ************************************/
-void __MSG_process_cleanup(void *arg)
+void __MSG_process_cleanup(smx_process_t smx_proc)
 {
   /* arg is a pointer to a simix process, we can get the msg process with the field data */
-  m_process_t proc = ((smx_process_t) arg)->data;
+  m_process_t proc = SIMIX_req_process_get_data(smx_proc);
+#ifdef HAVE_TRACING
+  TRACE_msg_process_end(proc);
+#endif
   xbt_fifo_remove(msg_global->process_list, proc);
-  SIMIX_process_cleanup(arg);
-  free(proc->name);
-  proc->name = NULL;
-  free(proc->simdata);
-  proc->simdata = NULL;
+  SIMIX_process_cleanup(smx_proc);
+  if (proc->name) {
+    free(proc->name);
+    proc->name = NULL;
+  }
+  if (proc->simdata) {
+    free(proc->simdata);
+    proc->simdata = NULL;
+  }
   free(proc);
 
   return;
@@ -46,33 +50,35 @@ void __MSG_process_cleanup(void *arg)
 
 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
 void *_MSG_process_create_from_SIMIX(const char *name,
-                                    xbt_main_func_t code, void *data,
-                                    char *hostname, int argc, char **argv, xbt_dict_t properties)
+                                     xbt_main_func_t code, void *data,
+                                     char *hostname, int argc, char **argv,
+                                     xbt_dict_t properties)
 {
   m_host_t host = MSG_get_host_by_name(hostname);
-  return (void *) MSG_process_create_with_environment(name, code, data, host,
-                                                     argc, argv,properties);
+  return (void *) MSG_process_create_with_environment(name, code, data,
+                                                      host, argc, argv,
+                                                      properties);
 }
 
 /** \ingroup m_process_management
  * \brief Creates and runs a new #m_process_t.
  *
- * Does exactly the same as #MSG_process_create_with_arguments but without 
+ * Does exactly the same as #MSG_process_create_with_arguments but without
    providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
  * \sa MSG_process_create_with_arguments
  */
 m_process_t MSG_process_create(const char *name,
-                              xbt_main_func_t code, void *data,
-                              m_host_t host)
+                               xbt_main_func_t code, void *data,
+                               m_host_t host)
 {
   return MSG_process_create_with_environment(name, code, data, host, -1,
-                                            NULL,NULL);
+                                             NULL, NULL);
 }
 
 /** \ingroup m_process_management
  * \brief Creates and runs a new #m_process_t.
 
- * A constructor for #m_process_t taking four arguments and returning the 
+ * 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
@@ -95,18 +101,18 @@ m_process_t MSG_process_create(const char *name,
  */
 
 m_process_t MSG_process_create_with_arguments(const char *name,
-                                             xbt_main_func_t code,
-                                             void *data, m_host_t host,
-                                             int argc, char **argv)
+                                              xbt_main_func_t code,
+                                              void *data, m_host_t host,
+                                              int argc, char **argv)
 {
-  return MSG_process_create_with_environment(name, code, data, host, 
-                                            argc,argv,NULL);
+  return MSG_process_create_with_environment(name, code, data, host,
+                                             argc, argv, NULL);
 }
 
 /** \ingroup m_process_management
  * \brief Creates and runs a new #m_process_t.
 
- * A constructor for #m_process_t taking four arguments and returning the 
+ * 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
@@ -129,45 +135,60 @@ m_process_t MSG_process_create_with_arguments(const char *name,
  * \return The new corresponding object.
  */
 m_process_t MSG_process_create_with_environment(const char *name,
-                                             xbt_main_func_t code,
-                                             void *data, m_host_t host,
-                                             int argc, char **argv, xbt_dict_t properties)
+                                                xbt_main_func_t code,
+                                                void *data, m_host_t host,
+                                                int argc, char **argv,
+                                                xbt_dict_t properties)
 {
-  simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
+  simdata_process_t simdata = NULL;
   m_process_t process = xbt_new0(s_m_process_t, 1);
   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
 
+  simdata = xbt_new0(s_simdata_process_t, 1);
+
   /* Simulator Data */
   simdata->PID = msg_global->PID++;
+  simdata->waiting_action = NULL;
   simdata->waiting_task = NULL;
   simdata->m_host = host;
   simdata->argc = argc;
   simdata->argv = argv;
-  simdata->s_process = SIMIX_process_create(name, code,
-                                           (void *) process, host->name,
-                                           argc, argv, properties);
 
   if (SIMIX_process_self()) {
-    simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data);
+    simdata->PPID = MSG_process_get_PID(SIMIX_process_self_get_data());
   } else {
     simdata->PPID = -1;
   }
   simdata->last_errno = MSG_OK;
 
-
   /* Process structure */
   process->name = xbt_strdup(name);
   process->simdata = simdata;
   process->data = data;
-
   xbt_fifo_unshift(msg_global->process_list, process);
 
-  return process;
+  /* Let's create the process (SIMIX may decide to start it right now) */
+  simdata->s_process = SIMIX_req_process_create(name, code, (void *) process, host->name,
+                                                argc, argv, properties);
+
+  if (!simdata->s_process) {
+    /* Undo everything we have just changed */
+    msg_global->PID--;
+    xbt_fifo_remove(msg_global->process_list, process);
+    xbt_free(process->name);
+    xbt_free(process);
+    xbt_free(simdata);
+    return NULL;
+  }
 
+  return process;
 }
 
 void _MSG_process_kill_from_SIMIX(void *p)
 {
+#ifdef HAVE_TRACING
+  TRACE_msg_process_kill((m_process_t) p);
+#endif
   MSG_process_kill((m_process_t) p);
 }
 
@@ -180,20 +201,19 @@ void MSG_process_kill(m_process_t process)
 {
   simdata_process_t p_simdata = process->simdata;
 
+#ifdef HAVE_TRACING
+  TRACE_msg_process_kill(process);
+#endif
+
   DEBUG3("Killing %s(%d) on %s",
-        process->name, p_simdata->PID, p_simdata->m_host->name);
-
-  if (p_simdata->waiting_task) {
-    DEBUG1("Canceling waiting task %s", p_simdata->waiting_task->name);
-    if (p_simdata->waiting_task->simdata->compute) {
-      SIMIX_action_cancel(p_simdata->waiting_task->simdata->compute);
-    } else if (p_simdata->waiting_task->simdata->comm) {
-      SIMIX_action_cancel(p_simdata->waiting_task->simdata->comm);
-    }
-  }
+         process->name, p_simdata->PID, p_simdata->m_host->name);
 
+  if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
+    SIMIX_req_comm_cancel(p_simdata->waiting_task->simdata->comm);
+  }
   xbt_fifo_remove(msg_global->process_list, process);
-  SIMIX_process_kill(process->simdata->s_process);
+  SIMIX_req_process_kill(process->simdata->s_process);
 
   return;
 }
@@ -201,20 +221,26 @@ void MSG_process_kill(m_process_t process)
 /** \ingroup m_process_management
  * \brief Migrates an agent to another location.
  *
- * This functions checks whether \a process and \a host are valid pointers
+ * This function checks whether \a process and \a host are valid pointers
    and change the value of the #m_host_t on which \a process is running.
  */
-MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host)
+MSG_error_t MSG_process_change_host(m_host_t host)
 {
-  xbt_die
-      ("MSG_process_change_host - not implemented yet - maybe useless function");
+  m_process_t process = MSG_process_self();
+  m_host_t now = process->simdata->m_host;
+  process->simdata->m_host = host;
+#ifdef HAVE_TRACING
+  TRACE_msg_process_change_host(process, now, host);
+#endif
+  SIMIX_req_process_change_host(process->simdata->s_process, now->name,
+                            host->name);
   return MSG_OK;
 }
 
 /** \ingroup m_process_management
  * \brief Return the user data of a #m_process_t.
  *
- * This functions checks whether \a process is a valid pointer or not 
+ * This function checks whether \a process is a valid pointer or not
    and return the user data associated to \a process if it is possible.
  */
 void *MSG_process_get_data(m_process_t process)
@@ -227,13 +253,12 @@ void *MSG_process_get_data(m_process_t process)
 /** \ingroup m_process_management
  * \brief Set the user data of a #m_process_t.
  *
- * This functions checks whether \a process is a valid pointer or not 
+ * This function checks whether \a process is a valid pointer or not
    and set the user data associated to \a process if it is possible.
  */
 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
 {
   xbt_assert0((process != NULL), "Invalid parameters");
-  xbt_assert0((process->data == NULL), "Data already set");
 
   process->data = data;
 
@@ -243,14 +268,14 @@ MSG_error_t MSG_process_set_data(m_process_t process, void *data)
 /** \ingroup m_process_management
  * \brief Return the location on which an agent is running.
  *
- * 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 
+ * This function 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.
  */
 m_host_t MSG_process_get_host(m_process_t process)
 {
   xbt_assert0(((process != NULL)
-              && (process->simdata)), "Invalid parameters");
+               && (process->simdata)), "Invalid parameters");
 
   return (((simdata_process_t) process->simdata)->m_host);
 }
@@ -259,8 +284,8 @@ m_host_t MSG_process_get_host(m_process_t process)
  *
  * \brief Return a #m_process_t given its PID.
  *
- * This functions search in the list of all the created m_process_t for a m_process_t 
-   whose PID is equal to \a PID. If no host is found, \c NULL is returned. 
+ * This function search in the list of all the created m_process_t for a m_process_t
+   whose PID is equal to \a PID. If no host is found, \c NULL is returned.
    Note that the PID are uniq in the whole simulation, not only on a given host.
  */
 m_process_t MSG_process_from_PID(int PID)
@@ -278,12 +303,12 @@ m_process_t MSG_process_from_PID(int PID)
 /** \ingroup m_process_management
  * \brief Returns the process ID of \a process.
  *
- * This functions checks whether \a process is a valid pointer or not 
+ * This function checks whether \a process is a valid pointer or not
    and return its PID (or 0 in case of problem).
  */
 int MSG_process_get_PID(m_process_t process)
 {
-  /* Do not raise an exception here: this function is used in the logs, 
+  /* Do not raise an exception here: this function is used in the logs,
      and it will be called back by the exception handling stuff */
   if (process == NULL || process->simdata == NULL)
     return 0;
@@ -294,14 +319,14 @@ int MSG_process_get_PID(m_process_t process)
 /** \ingroup m_process_management
  * \brief Returns the process ID of the parent of \a process.
  *
- * This functions checks whether \a process is a valid pointer or not 
-   and return its PID. Returns -1 if the agent has not been created by 
+ * This function checks whether \a process is a valid pointer or not
+   and return its PID. Returns -1 if the agent has not been created by
    another agent.
  */
 int MSG_process_get_PPID(m_process_t process)
 {
   xbt_assert0(((process != NULL)
-              && (process->simdata)), "Invalid parameters");
+               && (process->simdata)), "Invalid parameters");
 
   return (((simdata_process_t) process->simdata)->PPID);
 }
@@ -309,13 +334,14 @@ int MSG_process_get_PPID(m_process_t process)
 /** \ingroup m_process_management
  * \brief Return the name of an agent.
  *
- * This functions checks whether \a process is a valid pointer or not 
+ * This function checks whether \a process is a valid pointer or not
    and return its name.
  */
 const char *MSG_process_get_name(m_process_t process)
 {
-  xbt_assert0(((process != NULL)
-              && (process->simdata)), "Invalid parameters");
+  xbt_assert0(process, "Invalid parameter: process is NULL");
+  xbt_assert0(process->simdata,
+              "Invalid parameter: process->simdata is NULL");
 
   return (process->name);
 }
@@ -327,7 +353,8 @@ const char *MSG_process_get_name(m_process_t process)
  * \param name a property name
  * \return value of a property (or NULL if the property is not set)
  */
-const char* MSG_process_get_property_value(m_process_t process, char* name)
+const char *MSG_process_get_property_value(m_process_t process,
+                                           const char *name)
 {
   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
 }
@@ -335,20 +362,21 @@ const char* MSG_process_get_property_value(m_process_t process, char* name)
 /** \ingroup m_process_management
  * \brief Return the list of properties
  *
- * This functions returns all the parameters associated with a process
+ * This function returns all the parameters associated with a process
  */
 xbt_dict_t MSG_process_get_properties(m_process_t process)
 {
-   xbt_assert0((process != NULL), "Invalid parameters");
+  xbt_assert0((process != NULL), "Invalid parameters");
 
-  return (SIMIX_process_get_properties(((simdata_process_t)process->simdata)->s_process));
+  return (SIMIX_req_process_get_properties
+          (((simdata_process_t) process->simdata)->s_process));
 
 }
 
 /** \ingroup m_process_management
  * \brief Return the PID of the current agent.
  *
- * This functions returns the PID of the currently running #m_process_t.
+ * This function returns the PID of the currently running #m_process_t.
  */
 int MSG_process_self_PID(void)
 {
@@ -358,7 +386,7 @@ int MSG_process_self_PID(void)
 /** \ingroup m_process_management
  * \brief Return the PPID of the current agent.
  *
- * This functions returns the PID of the parent of the currently
+ * This function returns the PID of the parent of the currently
  * running #m_process_t.
  */
 int MSG_process_self_PPID(void)
@@ -369,49 +397,53 @@ int MSG_process_self_PPID(void)
 /** \ingroup m_process_management
  * \brief Return the current agent.
  *
- * This functions returns the currently running #m_process_t.
+ * This function returns the currently running #m_process_t.
  */
 m_process_t MSG_process_self(void)
 {
-  smx_process_t proc = SIMIX_process_self();
-  if (proc != NULL) {
-    return (m_process_t) proc->data;
-  } else {
-    return NULL;
-  }
-
+  /* we cannot make a SIMIX request here because this may create an exception or a logging
+     event, and both mechanisms call MSG_process_self() again (via xbt_getpid()) */
+  return (m_process_t) SIMIX_process_self_get_data();
 }
 
 /** \ingroup m_process_management
  * \brief Suspend the process.
  *
- * This functions suspend the process by suspending the task on which
+ * This function suspends the process by suspending the task on which
  * it was waiting for the completion.
  */
 MSG_error_t MSG_process_suspend(m_process_t process)
 {
   xbt_assert0(((process != NULL)
-              && (process->simdata)), "Invalid parameters");
+               && (process->simdata)), "Invalid parameters");
   CHECK_HOST();
 
-  SIMIX_process_suspend(process->simdata->s_process);
+#ifdef HAVE_TRACING
+  TRACE_msg_process_suspend(process);
+#endif
+
+  SIMIX_req_process_suspend(process->simdata->s_process);
   MSG_RETURN(MSG_OK);
 }
 
 /** \ingroup m_process_management
  * \brief Resume a suspended process.
  *
- * This functions resume a suspended process by resuming the task on
+ * This function resumes a suspended process by resuming the task on
  * which it was waiting for the completion.
  */
 MSG_error_t MSG_process_resume(m_process_t process)
 {
 
   xbt_assert0(((process != NULL)
-              && (process->simdata)), "Invalid parameters");
+               && (process->simdata)), "Invalid parameters");
   CHECK_HOST();
 
-  SIMIX_process_resume(process->simdata->s_process);
+#ifdef HAVE_TRACING
+  TRACE_msg_process_resume(process);
+#endif
+
+  SIMIX_req_process_resume(process->simdata->s_process);
   MSG_RETURN(MSG_OK);
 }
 
@@ -424,6 +456,11 @@ MSG_error_t MSG_process_resume(m_process_t process)
 int MSG_process_is_suspended(m_process_t process)
 {
   xbt_assert0(((process != NULL)
-              && (process->simdata)), "Invalid parameters");
-  return SIMIX_process_is_suspended(process->simdata->s_process);
+               && (process->simdata)), "Invalid parameters");
+  return SIMIX_req_process_is_suspended(process->simdata->s_process);
+}
+
+
+smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
+  return SIMIX_process_get_context(process->simdata->s_process);
 }