Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use 0 to indicate an invalid PID instead of -1. Someone may consider it unsigned...
[simgrid.git] / src / msg / m_process.c
index 920f92b..7e71699 100644 (file)
@@ -1,17 +1,62 @@
-/*     $Id$     */
-
-/* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
+/*     $Id$      */
+  
+/* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
+/* Copyright (c) 2007 Bruno Donassolo.                                      */
+/* 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 "msg/private.h"
+#include "xbt/sysdep.h"
+#include "xbt/log.h"
 
-#include"private.h"
-#include"xbt/sysdep.h"
-#include "xbt/error.h"
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(m_process, msg,
-                               "Logging specific to MSG (process)");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
+
+/** \defgroup m_process_management Management Functions of Agents
+ *  \brief This section describes the agent structure of MSG
+ *  (#m_process_t) and the functions for managing it.
+ */
+/** @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
+ *  some <em>private data</em>, executing in a <em>location</em>.
+ *  \see m_process_t
+ */
 
 /******************************** Process ************************************/
+/** \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 
+   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,
+                              m_process_code_t code, void *data,
+                              m_host_t host)
+{
+  return MSG_process_create_with_arguments(name, code, data, host, -1, NULL);
+}
+
+static void MSG_process_cleanup(void *arg)
+{
+       /* 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;
+  xbt_fifo_remove(msg_global->process_list, proc);
+       SIMIX_process_cleanup(arg);
+  free(proc->name);
+  proc->name = NULL;
+  free(proc->simdata);
+  proc->simdata = NULL;
+  free(proc);
+
+       return;
+}
+
 /** \ingroup m_process_management
  * \brief Creates and runs a new #m_process_t.
 
@@ -27,57 +72,46 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(m_process, msg,
    name contains the word get), in \ref m_task_management (to create
    or destroy some #m_task_t for example) and in \ref
    msg_gos_functions (to handle file transfers and task processing).
- * \param data a pointer to any data may want to attach to the new
+ * \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
  * \see m_process_t
  * \return The new corresponding object.
  */
-m_process_t MSG_process_create(const char *name,
-                              m_process_code_t code, void *data,
-                              m_host_t host)
-{
-  return MSG_process_create_with_arguments(name, code, data, host, -1, NULL);
-}
 
-static void MSG_process_cleanup(void *arg)
+
+
+m_process_t __MSG_process_create_with_arguments(const char *name,
+                                             m_process_code_t code, void *data,
+                                             char * hostname, int argc, char **argv)
 {
-  xbt_fifo_remove(msg_global->process_list, arg);
-  xbt_fifo_remove(msg_global->process_to_run, arg);
-  xbt_fifo_remove(((m_process_t) arg)->simdata->host->simdata->process_list, arg);
-  xbt_free(((m_process_t) arg)->name);
-  xbt_free(((m_process_t) arg)->simdata);
-  xbt_free(arg);
+       m_host_t host = MSG_get_host_by_name(hostname);
+       return MSG_process_create_with_arguments(name,code,data,host,argc,argv);
 }
 
-
 m_process_t MSG_process_create_with_arguments(const char *name,
                                              m_process_code_t code, void *data,
                                              m_host_t host, int argc, char **argv)
 {
   simdata_process_t simdata = xbt_new0(s_simdata_process_t,1);
   m_process_t process = xbt_new0(s_m_process_t,1);
-  m_process_t self = NULL;
-  static int PID = 1;
-
   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
-  /* Simulator Data */
 
-  simdata->PID = PID++;
+  /* Simulator Data */
+  simdata->PID = msg_global->PID++;
+       simdata->waiting_task = NULL;
   simdata->host = host;
-  simdata->waiting_task = NULL;
   simdata->argc = argc;
   simdata->argv = argv;
-  simdata->context = xbt_context_new(code, NULL, NULL, 
-                                    MSG_process_cleanup, process, 
-                                    simdata->argc, simdata->argv);
-
-  if((self=msg_global->current_process)) {
-    simdata->PPID = MSG_process_get_PID(self);
-  } else {
-    simdata->PPID = -1;
-  }
+       simdata->smx_process = SIMIX_process_create(name, (smx_process_code_t)code, (void*)process, host->name, argc, argv, MSG_process_cleanup );
+
+       if (SIMIX_process_self()) {
+               simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data);
+       }
+       else simdata->PPID = -1;
   simdata->last_errno=MSG_OK;
 
 
@@ -86,17 +120,36 @@ m_process_t MSG_process_create_with_arguments(const char *name,
   process->simdata = simdata;
   process->data = data;
 
-  xbt_fifo_push(host->simdata->process_list, process);
+       xbt_fifo_unshift(msg_global->process_list, process); 
 
-  /* /////////////// FIX du current_process !!! ////////////// */
-  self = msg_global->current_process;
-  xbt_context_start(process->simdata->context);
-  msg_global->current_process = self;
+  return process;
+}
 
-  xbt_fifo_push(msg_global->process_list, process);
-  xbt_fifo_push(msg_global->process_to_run, process);
+/** \ingroup m_process_management
+ * \param process poor victim
+ *
+ * This function simply kills a \a process... scarry isn't it ? :)
+ */
+void MSG_process_kill(m_process_t process)
+{
+  simdata_process_t p_simdata = process->simdata;
+
+  DEBUG3("Killing %s(%d) on %s",process->name, p_simdata->PID, p_simdata->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);
+    } 
+  }
 
-  return process;
+  xbt_fifo_remove(msg_global->process_list,process);
+       SIMIX_process_kill(process->simdata->smx_process);
+
+       return;
 }
 
 /** \ingroup m_process_management
@@ -107,18 +160,7 @@ m_process_t MSG_process_create_with_arguments(const char *name,
  */
 MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host)
 {
-  simdata_process_t simdata = NULL;
-
-  /* Sanity check */
-
-  xbt_assert0(((process) && (process->simdata)
-         && (host)), "Invalid parameters");
-  simdata = process->simdata;
-
-  xbt_fifo_remove(simdata->host->simdata->process_list,process);
-  simdata->host = host;
-  xbt_fifo_push(host->simdata->process_list,process);
-
+       xbt_die("MSG_process_change_host - not implemented yet - maybe useless function");
   return MSG_OK;
 }
 
@@ -188,16 +230,18 @@ m_process_t MSG_process_from_PID(int PID)
  * \brief Returns the process ID of \a process.
  *
  * This functions checks whether \a process is a valid pointer or not 
-   and return its PID.
+   and return its PID (or 0 in case of problem).
  */
 int MSG_process_get_PID(m_process_t process)
 {
-  xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
+  /* 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;
 
   return (((simdata_process_t) process->simdata)->PID);
 }
 
-
 /** \ingroup m_process_management
  * \brief Returns the process ID of the parent of \a process.
  *
@@ -253,7 +297,14 @@ int MSG_process_self_PPID(void)
  */
 m_process_t MSG_process_self(void)
 {
-  return msg_global->current_process;
+       smx_process_t proc = SIMIX_process_self();
+       if (proc != NULL) {
+               return (m_process_t)proc->data;
+       }
+       else { 
+               return NULL;
+       }
+
 }
 
 /** \ingroup m_process_management
@@ -264,37 +315,11 @@ m_process_t MSG_process_self(void)
  */
 MSG_error_t MSG_process_suspend(m_process_t process)
 {
-  simdata_process_t simdata = NULL;
-  simdata_task_t simdata_task = NULL;
-  int i;
-
-  xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
-
-  if(process!=MSG_process_self()) {
-    simdata = process->simdata;
-    
-    xbt_assert0(simdata->waiting_task,"Process not waiting for anything else. Weird !");
-
-    simdata_task = simdata->waiting_task->simdata;
-
-    xbt_assert0(((simdata_task->compute)||(simdata_task->comm))&&
-               !((simdata_task->comm)&&(simdata_task->comm)),
-               "Got a problem in deciding which action to choose !");
-    if(simdata_task->compute) 
-      surf_workstation_resource->extension_public->suspend(simdata_task->compute);
-    else
-      surf_workstation_resource->extension_public->suspend(simdata_task->comm);
-  } else {
-    m_task_t dummy = MSG_TASK_UNINITIALIZED;
-    dummy = MSG_task_create("suspended", 0.0, 0, NULL);
-
-    __MSG_task_execute(process,dummy);
-    surf_workstation_resource->extension_public->suspend(dummy->simdata->compute);
-    __MSG_wait_for_computation(process,dummy);
-
-    MSG_task_destroy(dummy);
-  }
-  return MSG_OK;
+  xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
+  CHECK_HOST();
+
+       SIMIX_process_suspend(process->simdata->smx_process);
+  MSG_RETURN(MSG_OK);
 }
 
 /** \ingroup m_process_management
@@ -305,25 +330,11 @@ MSG_error_t MSG_process_suspend(m_process_t process)
  */
 MSG_error_t MSG_process_resume(m_process_t process)
 {
-  simdata_process_t simdata = NULL;
-  simdata_task_t simdata_task = NULL;
-  int i;
 
   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
   CHECK_HOST();
 
-  simdata = process->simdata;
-  if(!(simdata->waiting_task)) {
-    xbt_assert0(0,"Process not waiting for anything else. Weird !");
-    return MSG_WARNING;
-  }
-  simdata_task = simdata->waiting_task->simdata;
-
-  if(simdata_task->compute) 
-    surf_workstation_resource->extension_public->resume(simdata_task->compute);
-  else 
-    surf_workstation_resource->extension_public->resume(simdata_task->comm);
-
+       SIMIX_process_resume(process->simdata->smx_process);
   MSG_RETURN(MSG_OK);
 }
 
@@ -333,24 +344,9 @@ MSG_error_t MSG_process_resume(m_process_t process)
  * This checks whether a process is suspended or not by inspecting the
  * task on which it was waiting for the completion.
  */
-int MSG_process_isSuspended(m_process_t process)
+int MSG_process_is_suspended(m_process_t process)
 {
-  simdata_process_t simdata = NULL;
-  simdata_task_t simdata_task = NULL;
-  int i;
-  
   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
-
-  simdata = process->simdata;
-  if(!(simdata->waiting_task)) {
-    xbt_assert0(0,"Process not waiting for anything else. Weird !");
-    return 0;
-  }
-
-  simdata_task = simdata->waiting_task->simdata;
-
-  if(simdata_task->compute) 
-    return surf_workstation_resource->extension_public->is_suspended(simdata_task->compute);
-  else 
-    return surf_workstation_resource->extension_public->is_suspended(simdata_task->comm);
+       return SIMIX_process_is_suspended(process->simdata->smx_process);
 }
+