Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Don't throw the impossible when the user cancels a non-running task
[simgrid.git] / src / msg / task.c
index ebe69c3..6d3065f 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. */
@@ -26,6 +23,9 @@
  *  <em>message size</em> and some <em>private data</em>.
  */
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg,
+                                "Logging specific to MSG (task)");
+
 /********************************* Task **************************************/
 /** \ingroup m_task_management
  * \brief Creates a new #m_task_t.
  * \return The new corresponding object.
  */
 m_task_t MSG_task_create(const char *name, double compute_duration,
-                        double message_size, void *data)
+                         double message_size, void *data)
 {
-       m_task_t task = xbt_new(s_m_task_t,1);
-  simdata_task_t simdata = xbt_new(s_simdata_task_t,1);
+  m_task_t task = xbt_new(s_m_task_t, 1);
+  simdata_task_t simdata = xbt_new(s_simdata_task_t, 1);
   task->simdata = simdata;
   /* Task structure */
   task->name = xbt_strdup(name);
   task->data = data;
 
   /* Simulator Data */
+  simdata->host_nb = 0;
   simdata->computation_amount = compute_duration;
   simdata->message_size = message_size;
   simdata->rate = -1.0;
   simdata->priority = 1.0;
-  simdata->using = 1;
+  simdata->isused = 0;
   simdata->sender = NULL;
   simdata->receiver = NULL;
-       simdata->cond = SIMIX_cond_init();
-       simdata->mutex = SIMIX_mutex_init();
-       simdata->compute = NULL;
-       simdata->comm = NULL;
+  simdata->compute = NULL;
+  simdata->comm = NULL;
 
-       simdata->host_list = NULL;
-       simdata->comp_amount = NULL;
-       simdata->comm_amount = NULL;
+  simdata->host_list = NULL;
+  simdata->comp_amount = NULL;
+  simdata->comm_amount = NULL;
+#ifdef HAVE_TRACING
+  TRACE_msg_task_create(task);
+#endif
 
   return task;
 }
@@ -79,16 +81,29 @@ m_task_t MSG_task_create(const char *name, double compute_duration,
 /** \ingroup m_task_management
  * \brief Return the user data of a #m_task_t.
  *
- * This functions checks whether \a task is a valid pointer or not and return
+ * This function checks whether \a task is a valid pointer or not and return
    the user data associated to \a task if it is possible.
  */
 void *MSG_task_get_data(m_task_t task)
 {
-  xbt_assert0((task != NULL), "Invalid parameter");
+  xbt_assert((task != NULL), "Invalid parameter");
 
   return (task->data);
 }
 
+/** \ingroup m_task_management
+ * \brief Sets the user data of a #m_task_t.
+ *
+ * This function allows to associate a new pointer to
+   the user data associated of \a task.
+ */
+void MSG_task_set_data(m_task_t task, void *data)
+{
+  xbt_assert((task != NULL), "Invalid parameter");
+
+  task->data = data;
+}
+
 /** \ingroup m_task_management
  * \brief Return the sender of a #m_task_t.
  *
@@ -96,8 +111,8 @@ void *MSG_task_get_data(m_task_t task)
  */
 m_process_t MSG_task_get_sender(m_task_t task)
 {
-   xbt_assert0(task, "Invalid parameters");
-   return ((simdata_task_t) task->simdata)->sender;
+  xbt_assert(task, "Invalid parameters");
+  return ((simdata_task_t) task->simdata)->sender;
 }
 
 /** \ingroup m_task_management
@@ -107,8 +122,8 @@ m_process_t MSG_task_get_sender(m_task_t task)
  */
 m_host_t MSG_task_get_source(m_task_t task)
 {
-   xbt_assert0(task, "Invalid parameters");
-   return ((simdata_task_t) task->simdata)->source;
+  xbt_assert(task, "Invalid parameters");
+  return ((simdata_task_t) task->simdata)->source;
 }
 
 /** \ingroup m_task_management
@@ -118,10 +133,20 @@ m_host_t MSG_task_get_source(m_task_t task)
  */
 const char *MSG_task_get_name(m_task_t task)
 {
-   xbt_assert0(task, "Invalid parameters");
-   return task->name;
+  xbt_assert(task, "Invalid parameters");
+  return task->name;
 }
 
+/** \ingroup m_task_management
+ * \brief Return the name of a #m_task_t.
+ *
+ * This functions allows to associate a name to a task
+ */
+void MSG_task_set_name(m_task_t task, const char *name)
+{
+  xbt_assert(task, "Invalid parameters");
+  task->name = xbt_strdup(name);
+}
 
 /** \ingroup m_task_management
  * \brief Destroy a #m_task_t.
@@ -132,27 +157,31 @@ const char *MSG_task_get_name(m_task_t task)
 MSG_error_t MSG_task_destroy(m_task_t task)
 {
   smx_action_t action = NULL;
-  xbt_assert0((task != NULL), "Invalid parameter");
-
-       /* why? if somebody is using, then you can't free! ok... but will return MSG_OK? when this task will be destroyed? isn't the user code wrong? */
-  task->simdata->using--;
-  if(task->simdata->using>0) return MSG_OK;
+  xbt_assert((task != NULL), "Invalid parameter");
 
-  if(task->name) free(task->name);
+  /* why? if somebody is using, then you can't free! ok... but will return MSG_OK? when this task will be destroyed? isn't the user code wrong? */
+  if (task->simdata->isused > 0) {
+    XBT_DEBUG("Cannot destroy task %p since somebody is using it", task);
+    return MSG_OK;
+  }
+#ifdef HAVE_TRACING
+  TRACE_msg_task_destroy(task);
+#endif
 
-       SIMIX_cond_destroy(task->simdata->cond);
-       SIMIX_mutex_destroy(task->simdata->mutex);
+  if (task->name)
+    free(task->name);
 
   action = task->simdata->compute;
-  if(action) SIMIX_action_destroy(action);
-  action = task->simdata->comm;
-  if(action) SIMIX_action_destroy(action);
-       /* parallel tasks only */ 
-  if(task->simdata->host_list) xbt_free(task->simdata->host_list);
-       
-       /* free main structures */
-       xbt_free(task->simdata);
-       xbt_free(task);
+  if (action)
+    SIMIX_req_host_execution_destroy(action);
+
+  /* parallel tasks only */
+  if (task->simdata->host_list)
+    xbt_free(task->simdata->host_list);
+
+  /* free main structures */
+  xbt_free(task->simdata);
+  xbt_free(task);
 
   return MSG_OK;
 }
@@ -160,58 +189,104 @@ MSG_error_t MSG_task_destroy(m_task_t task)
 
 /** \ingroup m_task_management
  * \brief Cancel a #m_task_t.
- * \param task the taskt to cancel. If it was executed or transfered, it 
+ * \param task the task to cancel. If it was executed or transfered, it
           stops the process that were working on it.
  */
 MSG_error_t MSG_task_cancel(m_task_t task)
 {
-  xbt_assert0((task != NULL), "Invalid parameter");
+  xbt_assert((task != NULL), "Invalid parameter");
 
-  if(task->simdata->compute) {
-               SIMIX_action_cancel(task->simdata->compute);
-    return MSG_OK;
+  if (task->simdata->compute) {
+    SIMIX_req_host_execution_cancel(task->simdata->compute);
   }
-  if(task->simdata->comm) {
-               SIMIX_action_cancel(task->simdata->comm);
-    return MSG_OK;
+  else if (task->simdata->comm) {
+    SIMIX_req_comm_cancel(task->simdata->comm);
   }
-
-  return MSG_FATAL;
+  else {
+    XBT_DEBUG("Task %p will not be cancelled since it is not running", task);
+  }
+  return MSG_OK;
 }
 
 /** \ingroup m_task_management
  * \brief Returns the computation amount needed to process a task #m_task_t.
  *        Once a task has been processed, this amount is thus set to 0...
  */
-double MSG_task_get_compute_duration(m_task_t task) 
+double MSG_task_get_compute_duration(m_task_t task)
 {
-  xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
+  xbt_assert((task != NULL)
+              && (task->simdata != NULL), "Invalid parameter");
 
   return task->simdata->computation_amount;
 }
 
+
+/** \ingroup m_task_management
+ * \brief set the computation amount needed to process a task #m_task_t.
+ */
+
+void MSG_task_set_compute_duration(m_task_t task,
+                                   double computation_amount)
+{
+  xbt_assert(task, "Invalid parameter");
+  task->simdata->computation_amount = computation_amount;
+
+}
+
 /** \ingroup m_task_management
  * \brief Returns the remaining computation amount of a task #m_task_t.
  *
  */
 double MSG_task_get_remaining_computation(m_task_t task)
 {
-  xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
+  xbt_assert((task != NULL)
+              && (task->simdata != NULL), "Invalid parameter");
 
-  if(task->simdata->compute) {
-    return SIMIX_action_get_remains(task->simdata->compute);
+  if (task->simdata->compute) {
+    return SIMIX_req_host_execution_get_remains(task->simdata->compute);
   } else {
     return task->simdata->computation_amount;
   }
 }
 
+/** \ingroup m_task_management
+ * \brief Returns the total amount received by a task #m_task_t.
+ *        If the communication does not exist it will return 0.
+ *        So, if the communication has FINISHED or FAILED it returns
+ *        zero.
+ */
+double MSG_task_get_remaining_communication(m_task_t task)
+{
+  xbt_assert((task != NULL)
+              && (task->simdata != NULL), "Invalid parameter");
+  XBT_DEBUG("calling SIMIX_req_communication_get_remains(%p)",
+         task->simdata->comm);
+  return SIMIX_req_comm_get_remains(task->simdata->comm);
+}
+
+#ifdef HAVE_LATENCY_BOUND_TRACKING
+/** \ingroup m_task_management
+ * \brief Return 1 if communication task is limited by latency, 0 otherwise
+ *
+ */
+int MSG_task_is_latency_bounded(m_task_t task)
+{
+  xbt_assert((task != NULL)
+              && (task->simdata != NULL), "Invalid parameter");
+  XBT_DEBUG("calling SIMIX_req_communication_is_latency_bounded(%p)",
+         task->simdata->comm);
+  return SIMIX_req_comm_is_latency_bounded(task->simdata->comm);
+}
+#endif
+
 /** \ingroup m_task_management
  * \brief Returns the size of the data attached to a task #m_task_t.
  *
  */
-double MSG_task_get_data_size(m_task_t task) 
+double MSG_task_get_data_size(m_task_t task)
 {
-  xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
+  xbt_assert((task != NULL)
+              && (task->simdata != NULL), "Invalid parameter");
 
   return task->simdata->message_size;
 }
@@ -224,12 +299,13 @@ double MSG_task_get_data_size(m_task_t task)
  *        cpu power than the other ones.
  *
  */
-void MSG_task_set_priority(m_task_t task, double priority) 
+void MSG_task_set_priority(m_task_t task, double priority)
 {
-  xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
+  xbt_assert((task != NULL)
+              && (task->simdata != NULL), "Invalid parameter");
 
-  task->simdata->priority = 1/priority;
-  if(task->simdata->compute)
-               SIMIX_action_set_priority(task->simdata->compute, task->simdata->priority);
+  task->simdata->priority = 1 / priority;
+  if (task->simdata->compute)
+    SIMIX_req_host_execution_set_priority(task->simdata->compute,
+                                      task->simdata->priority);
 }
-