Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
avoid any name clashes with msg/private.h so that the java interface can do crude...
[simgrid.git] / src / simix / smx_process.c
index 3f17ace..292177f 100644 (file)
 #include "private.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
+
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
                                "Logging specific to SIMIX (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.
- *    \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.
+/**
+ * \brief Creates and runs a new #smx_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
+ * 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
  */
-smx_process_t SIMIX_process_create(const char *name,
-                              smx_process_code_t code, void *data,
-                              smx_host_t host)
-{
-  return SIMIX_process_create_with_arguments(name, code, data, host, -1, NULL);
-}
 
-static void SIMIX_process_cleanup(void *arg)
+
+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->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);
 }
 
-/** \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 
- * 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 code is a function describing the behavior of the agent. It
-   should then only use functions described in \ref
-   m_process_management (to create a new #m_process_t for example),
-   in \ref m_host_management (only the read-only functions i.e. whose
-   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 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.
+/** 
+ * \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 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
+ * \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_with_arguments(const char *name,
+smx_process_t SIMIX_process_create(const char *name,
                                              smx_process_code_t code, void *data,
-                                             smx_host_t host, int argc, char **argv)
+                                             const char * hostname, int argc, char **argv, void * clean_process_function)
 {
-  simdata_process_t simdata = xbt_new0(s_simdata_process_t,1);
+  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_host_t host = SIMIX_host_get_by_name(hostname);
 
   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
   /* Simulator Data */
 
   simdata->host = host;
+       simdata->mutex = NULL;
+       simdata->cond = NULL;
   simdata->argc = argc;
   simdata->argv = argv;
-  simdata->context = xbt_context_new(code, NULL, NULL, 
-                                    SIMIX_process_cleanup, process, 
-                                    simdata->argc, simdata->argv);
-
-  simdata->last_errno=SIMIX_OK;
-
+       if (clean_process_function) {
+       simdata->context = xbt_context_new(code, NULL, NULL, 
+                                            clean_process_function, process, 
+                                            simdata->argc, simdata->argv);
+       }
+       else {
+       simdata->context = xbt_context_new(code, NULL, NULL, 
+                                            SIMIX_process_cleanup, process, 
+                                            simdata->argc, simdata->argv);
+       }
 
   /* Process structure */
   process->name = xbt_strdup(name);
   process->simdata = simdata;
   process->data = data;
 
-  xbt_swag_insert_at_head(process, host->simdata->process_list);
+  xbt_swag_insert(process, host->simdata->process_list);
 
   /* *************** FIX du current_process !!! *************** */
   self = simix_global->current_process;
   xbt_context_start(process->simdata->context);
   simix_global->current_process = self;
 
-  xbt_swag_insert_at_head(process,simix_global->process_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_at_head(process,simix_global->process_to_run);
+  xbt_swag_insert(process,simix_global->process_to_run);
 
   return process;
 }
 
-/** \ingroup m_process_management
+
+/** \brief Kill a SIMIX process
+ *
+ * This function simply kills a \a process... scarry isn't it ? :). Removes it from the mutex or condition that it can be blocked.
  * \param process poor victim
  *
- * This function simply kills a \a process... scarry isn't it ? :)
  */
 void SIMIX_process_kill(smx_process_t process)
-{
-  //int i;
-  simdata_process_t p_simdata = process->simdata;
-  //simdata_host_t h_simdata= p_simdata->host->simdata;
-  //int _cursor;
-  //smx_process_t proc = NULL;
+{      
+  smx_simdata_process_t p_simdata = process->simdata;
 
   DEBUG2("Killing %s on %s",process->name, p_simdata->host->name);
   
-  /*
-  
-  if(p_simdata->waiting_task) {
-    xbt_dynar_foreach(p_simdata->waiting_task->simdata->sleeping,_cursor,proc) {
-      if(proc==process) 
-       xbt_dynar_remove_at(p_simdata->waiting_task->simdata->sleeping,_cursor,&proc);
-    }
-    if(p_simdata->waiting_task->simdata->compute)
-      surf_workstation_resource->common_public->
-       action_free(p_simdata->waiting_task->simdata->compute);
-    else if (p_simdata->waiting_task->simdata->comm) {
-      surf_workstation_resource->common_public->
-       action_change_state(p_simdata->waiting_task->simdata->comm,SURF_ACTION_FAILED);
-      surf_workstation_resource->common_public->
-       action_free(p_simdata->waiting_task->simdata->comm);
-    } else {
-      xbt_die("UNKNOWN STATUS. Please report this bug.");
-    }
-  }
-
-  if ((i==msg_global->max_channel) && (process!=MSG_process_self()) && 
-      (!p_simdata->waiting_task)) {
-    xbt_die("UNKNOWN STATUS. Please report this bug.");
-  }
-*/
+       if (p_simdata->mutex) {
+               xbt_swag_remove(process,p_simdata->mutex->sleeping);
+       }
+       if (p_simdata->cond) {
+               xbt_swag_remove(process,p_simdata->cond->sleeping);
+       }
   xbt_swag_remove(process,simix_global->process_to_run);
   xbt_swag_remove(process,simix_global->process_list);
-  xbt_context_free(process->simdata->context);
+  xbt_context_kill(process->simdata->context);
 
   if(process==SIMIX_process_self()) {
     /* I just killed myself */
@@ -164,34 +126,12 @@ void SIMIX_process_kill(smx_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
-   and change the value of the #m_host_t on which \a process is running.
- */
-SIMIX_error_t SIMIX_process_change_host(smx_process_t process, smx_host_t host)
-{
-  simdata_process_t simdata = NULL;
-
-  /* Sanity check */
-
-  xbt_assert0(((process) && (process->simdata)
-         && (host)), "Invalid parameters");
-  simdata = process->simdata;
-
-  xbt_swag_remove(process,simdata->host->simdata->process_list);
-  simdata->host = host;
-  xbt_swag_insert_at_head(process,host->simdata->process_list);
-
-  return SIMIX_OK;
-}
-
-/** \ingroup m_process_management
- * \brief Return the user data of a #m_process_t.
+/**
+ * \brief Return the user data of a #smx_process_t.
  *
- * 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.
+ * 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.
+ * \param process SIMIX process
+ * \return A void pointer to the user data
  */
 void *SIMIX_process_get_data(smx_process_t process)
 {
@@ -200,41 +140,43 @@ void *SIMIX_process_get_data(smx_process_t process)
   return (process->data);
 }
 
-/** \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 
-   and set the user data associated to \a process if it is possible.
+ * 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.
+ * \param process SIMIX process
+ * \param data User data
  */
-SIMIX_error_t SIMIX_process_set_data(smx_process_t process,void *data)
+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 SIMIX_OK;
+  return ;
 }
 
-/** \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 
-   process 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 process is running.
+ * \param process SIMIX process
+ * \return SIMIX host
  */
 smx_host_t SIMIX_process_get_host(smx_process_t process)
 {
   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 
-  return (((simdata_process_t) process->simdata)->host);
+  return (process->simdata->host);
 }
 
-/** \ingroup m_process_management
+/**
  * \brief Return the name of an agent.
  *
- * This functions checks whether \a process is a valid pointer or not 
-   and return its name.
+ * This functions checks whether \a process is a valid pointer or not and return its name.
+ * \param process SIMIX process
+ * \return The process name
  */
 const char *SIMIX_process_get_name(smx_process_t process)
 {
@@ -243,43 +185,39 @@ const char *SIMIX_process_get_name(smx_process_t process)
   return (process->name);
 }
 
-/** \ingroup m_process_management
+/**
  * \brief Return the current agent.
  *
- * This functions returns the currently running #m_process_t.
+ * This functions returns the currently running #smx_process_t.
+ * \return The SIMIX process
  */
 smx_process_t SIMIX_process_self(void)
 {
   return simix_global ? simix_global->current_process : NULL;
 }
 
-/** \ingroup m_process_management
+/**
  * \brief Suspend the process.
  *
- * This functions suspend the process by suspending the task on which
- * it was waiting for the completion.
+ * This functions suspend the process by suspending the action on which it was waiting for the completion.
+ *     \param process SIMIX process
  */
-SIMIX_error_t SIMIX_process_suspend(smx_process_t process)
+void SIMIX_process_suspend(smx_process_t process)
 {
-  simdata_process_t simdata = NULL;
-       smx_action_t dummy;
+  smx_simdata_process_t simdata = NULL;
        
   xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
 
   if(process!=SIMIX_process_self()) {
     simdata = process->simdata;
     
-               if ( (simdata->mutex == NULL) && (simdata->cond == NULL) ) {
-                       /* Ops, I don't know what to do yet. */
-
-               }
-               else if (simdata->mutex) {
+               if (simdata->mutex) {
                        /* process blocked on a mutex, only set suspend=1 */
                        simdata->suspended = 1;
                }
                else if (simdata->cond){
                        /* process blocked cond, suspend all actions */
-                       
+
                        /* temporaries variables */ 
                        smx_cond_t c;
                        xbt_fifo_item_t i;
@@ -288,77 +226,81 @@ SIMIX_error_t SIMIX_process_suspend(smx_process_t process)
                        simdata->suspended = 1;
                        c = simdata->cond;
                        xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
-                                surf_workstation_resource->common_public->suspend(act->simdata->surf_action);
+                               surf_workstation_resource->common_public->suspend(act->simdata->surf_action);
                        }
                }
-               else xbt_assert0(0, "Unknown process status");
-
+               else {
+                       simdata->suspended = 1;
+               }
   }
        else {
                /* process executing, I can create an action and suspend it */
-               dummy = SIMIX_execute(SIMIX_process_get_host(process)->simdata->host, 0);
-               process->simdata->block_action = dummy;
-
                process->simdata->suspended = 1;
-               surf_workstation_resource->common_public->suspend(dummy->simdata->surf_action);
-               __SIMIX_wait_for_action(process,dummy);
-               SIMIX_action_destroy(dummy);
-               process->simdata->suspended = 0;
-
+               smx_action_t dummy;
+               smx_cond_t cond;
+               char name[] = "dummy";
+
+               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_register_condition_to_action(dummy,cond);
+               SIMIX_register_action_to_condition(dummy,cond);
+               __SIMIX_cond_wait(cond);        
+               //SIMIX_action_destroy(dummy);
+               //SIMIX_cond_destroy(cond);
        }
-  return SIMIX_OK;
+  return ;
 }
 
-/** \ingroup m_process_management
+/**
  * \brief Resume a suspended process.
  *
- * This functions resume a suspended process by resuming the task on
- * which it was waiting for the completion.
+ * This functions resume a suspended process by resuming the task on which it was waiting for the completion.
+ * \param process SIMIX process
  */
-SIMIX_error_t SIMIX_process_resume(smx_process_t process)
+void SIMIX_process_resume(smx_process_t process)
 {
-  simdata_process_t simdata = NULL;
+  smx_simdata_process_t simdata = NULL;
 
   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
-  CHECK_HOST();
+  SIMIX_CHECK_HOST();
 
   if(process == SIMIX_process_self()) {
-    SIMIX_RETURN(SIMIX_OK);
+               return; 
   }
 
   simdata = process->simdata;
-
   if(simdata->mutex) {
+               DEBUG0("Resume process blocked on a mutex");
     simdata->suspended = 0; /* He'll wake up by itself */
-    SIMIX_RETURN(SIMIX_OK);
+               return; 
   }
        else if (simdata->cond) {
+               DEBUG0("Resume process blocked on a conditional");
                /* temporaries variables */ 
                smx_cond_t c;
                xbt_fifo_item_t i;
                smx_action_t act;
-
                simdata->suspended = 0;
                c = simdata->cond;
                xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
                        surf_workstation_resource->common_public->resume(act->simdata->surf_action);
                }
-    SIMIX_RETURN(SIMIX_OK);
+               return;
        }
-       else if (simdata->block_action){
+       else {
                simdata->suspended = 0;
-               surf_workstation_resource->common_public->resume(simdata->block_action->simdata->surf_action);
-    SIMIX_RETURN(SIMIX_OK);
+               xbt_swag_insert(process,simix_global->process_to_run);
        }
-       else xbt_assert0(0, "Unknown process status");
 
 }
 
-/** \ingroup m_process_management
+/**
  * \brief Returns true if the process is suspended .
  *
- * This checks whether a process is suspended or not by inspecting the
- * task on which it was waiting for the completion.
+ * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
+ * \param process SIMIX process
+ * \return 1, if the process is suspended, else 0.
  */
 int SIMIX_process_is_suspended(smx_process_t process)
 {
@@ -367,112 +309,5 @@ int SIMIX_process_is_suspended(smx_process_t process)
   return (process->simdata->suspended);
 }
 
-int __SIMIX_process_block(double max_duration, const char *info)
-{
-
-  smx_process_t process = SIMIX_process_self();
-  smx_action_t dummy = NULL;
-
-  dummy = SIMIX_execute(SIMIX_process_get_host(process)->simdata->host, 0);
-       process->simdata->block_action = dummy;
-
-  process->simdata->blocked=1;
-
-  surf_workstation_resource->common_public->suspend(dummy->simdata->surf_action);
-  if(max_duration>=0)
-    surf_workstation_resource->common_public->set_max_duration(dummy->simdata->surf_action, 
-                                                              max_duration);
-       __SIMIX_wait_for_action(process,dummy);
-       SIMIX_action_destroy(dummy);
-       process->simdata->blocked=0;
-
-  if(process->simdata->suspended) {
-    DEBUG0("I've been suspended in the meantime");    
-    SIMIX_process_suspend(process);
-    DEBUG0("I've been resumed, let's keep going");    
-  }
-
-/*
-  m_task_t dummy = SIMIX_TASK_UNINITIALIZED;
-  char blocked_name[512];
-  snprintf(blocked_name,512,"blocked [%s] (%s:%s)",
-         info, process->name, process->simdata->host->name);
-
-  XBT_IN1(": max_duration=%g",max_duration);
-
-  dummy = MSG_task_create(blocked_name, 0.0, 0, NULL);
-  
-  PAJE_PROCESS_PUSH_STATE(process,"B",NULL);
-
-  process->simdata->blocked=1;
-  __MSG_task_execute(process,dummy);
-  surf_workstation_resource->common_public->suspend(dummy->simdata->compute);
-  if(max_duration>=0)
-    surf_workstation_resource->common_public->set_max_duration(dummy->simdata->compute, 
-                                                              max_duration);
-  __MSG_wait_for_computation(process,dummy);
-  MSG_task_destroy(dummy);
-  process->simdata->blocked=0;
-
-  if(process->simdata->suspended) {
-    DEBUG0("I've been suspended in the meantime");    
-    SIMIX_process_suspend(process);
-    DEBUG0("I've been resumed, let's keep going");    
-  }
-
-  PAJE_PROCESS_POP_STATE(process);
-
-  XBT_OUT;
-  */
-  return 1;
-}
-
-SIMIX_error_t __SIMIX_process_unblock(smx_process_t process)
-{
-  simdata_process_t simdata = NULL;
-  simdata_action_t simdata_action = NULL;
-
-  xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
-  CHECK_HOST();
-
-       simdata = process->simdata;
-  if(!(simdata->block_action)) {
-    xbt_assert0(0,"Process is not blocked !");
-    return SIMIX_WARNING;
-  }
-       simdata_action = simdata->block_action->simdata;
-  xbt_assert0(simdata->blocked,"Process not blocked");
-  surf_workstation_resource->common_public->resume(simdata_action->surf_action);
-  SIMIX_RETURN(SIMIX_OK);
-
-/*
-  simdata_process_t simdata = NULL;
-  simdata_task_t simdata_task = NULL;
-
-  xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
-  CHECK_HOST();
-
-  XBT_IN2(": %s unblocking %s", SIMIX_process_self()->name,process->name);
 
-  simdata = process->simdata;
-  if(!(simdata->waiting_task)) {
-    xbt_assert0(0,"Process not waiting for anything else. Weird !");
-    XBT_OUT;
-    return SIMIX_WARNING;
-  }
-  simdata_task = simdata->waiting_task->simdata;
-
-  xbt_assert0(simdata->blocked,"Process not blocked");
-
-  surf_workstation_resource->common_public->resume(simdata_task->compute);
-
-  XBT_OUT;
-*/
-}
 
-int __SIMIX_process_isBlocked(smx_process_t process)
-{
-  xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
-
-  return (process->simdata->blocked);
-}