Doc improvement: rename GOS into task usage

[simgrid.git] / src / msg / msg_task.c

diff --git a/src/msg/msg_task.c b/src/msg/msg_task.c
index f453edc..60d26b6 100644 (file)
--- a/src/msg/msg_task.c
+++ b/src/msg/msg_task.c
@@ -8,12 +8,8 @@
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 
-/** \defgroup m_task_management Managing functions of Tasks
- *  \brief This section describes the task structure of MSG
- *  (#m_task_t) and the functions for managing it.
- */
 /** @addtogroup m_task_management
- *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
+ *    
  * 
  *  Since most scheduling algorithms rely on a concept of task
  *  that can be either <em>computed</em> locally or
@@ -39,7 +35,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg,
    MSG_task_execute(). This value has to be >=0.
  * \param message_size a value of the amount of data (in bytes) needed to
    transfer this new task. If 0, then it cannot be transfered with
-   MSG_task_get() and MSG_task_put(). This value has to be >=0.
+   MSG_task_send() and MSG_task_recv(). This value has to be >=0.
  * \param data a pointer to any data 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_task_get_data.
@@ -78,6 +74,51 @@ m_task_t MSG_task_create(const char *name, double compute_duration,
   return task;
 }
 
+/*************** Begin GPU ***************/
+/** \ingroup m_task_management
+ * \brief Creates a new #m_gpu_task_t.
+
+ * A constructor for #m_gpu_task_t taking four arguments and returning
+   a pointer to the new created GPU task.
+
+ * \param name a name for the object. It is for user-level information
+   and can be NULL.
+
+ * \param compute_duration a value of the processing amount (in flop)
+   needed to process this new task. If 0, then it cannot be executed with
+   MSG_gpu_task_execute(). This value has to be >=0.
+
+ * \param dispatch_latency time in seconds to load this task on the GPU
+
+ * \param collect_latency time in seconds to transfer result from the GPU
+   back to the CPU (host) when done
+
+ * \see m_gpu_task_t
+ * \return The new corresponding object.
+ */
+m_gpu_task_t MSG_gpu_task_create(const char *name, double compute_duration,
+                         double dispatch_latency, double collect_latency)
+{
+  m_gpu_task_t task = xbt_new(s_m_gpu_task_t, 1);
+  simdata_gpu_task_t simdata = xbt_new(s_simdata_gpu_task_t, 1);
+  task->simdata = simdata;
+  /* Task structure */
+  task->name = xbt_strdup(name);
+
+  /* Simulator Data */
+  simdata->computation_amount = compute_duration;
+  simdata->dispatch_latency   = dispatch_latency;
+  simdata->collect_latency    = collect_latency;
+
+#ifdef HAVE_TRACING
+  //FIXME
+  /* TRACE_msg_gpu_task_create(task); */
+#endif
+
+  return task;
+}
+/*************** End GPU ***************/
+
 /** \ingroup m_task_management
  * \brief Return the user data of a #m_task_t.
  *
@@ -110,7 +151,15 @@ void MSG_task_set_data(m_task_t task, void *data)
  */
 void MSG_task_set_copy_callback(void (*callback)
     (m_task_t task, m_process_t sender, m_process_t receiver)) {
+
   msg_global->task_copy_callback = callback;
+
+  if (callback) {
+    SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
+  }
+  else {
+    SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
+  }
 }
 
 /** \ingroup m_task_management
@@ -186,7 +235,7 @@ MSG_error_t MSG_task_destroy(m_task_t task)
 
   action = task->simdata->compute;
   if (action)
-    SIMIX_req_host_execution_destroy(action);
+    simcall_host_execution_destroy(action);
 
   /* parallel tasks only */
   xbt_free(task->simdata->host_list);
@@ -209,10 +258,10 @@ MSG_error_t MSG_task_cancel(m_task_t task)
   xbt_assert((task != NULL), "Invalid parameter");
 
   if (task->simdata->compute) {
-    SIMIX_req_host_execution_cancel(task->simdata->compute);
+    simcall_host_execution_cancel(task->simdata->compute);
   }
   else if (task->simdata->comm) {
-    SIMIX_req_comm_cancel(task->simdata->comm);
+    simcall_comm_cancel(task->simdata->comm);
     task->simdata->isused = 0;
   }
   return MSG_OK;
@@ -253,7 +302,7 @@ double MSG_task_get_remaining_computation(m_task_t task)
               && (task->simdata != NULL), "Invalid parameter");
 
   if (task->simdata->compute) {
-    return SIMIX_req_host_execution_get_remains(task->simdata->compute);
+    return simcall_host_execution_get_remains(task->simdata->compute);
   } else {
     return task->simdata->computation_amount;
   }
@@ -269,9 +318,9 @@ 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)",
+  XBT_DEBUG("calling simcall_communication_get_remains(%p)",
          task->simdata->comm);
-  return SIMIX_req_comm_get_remains(task->simdata->comm);
+  return simcall_comm_get_remains(task->simdata->comm);
 }
 
 #ifdef HAVE_LATENCY_BOUND_TRACKING
@@ -283,9 +332,9 @@ 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)",
+  XBT_DEBUG("calling simcall_communication_is_latency_bounded(%p)",
          task->simdata->comm);
-  return SIMIX_req_comm_is_latency_bounded(task->simdata->comm);
+  return simcall_comm_is_latency_bounded(task->simdata->comm);
 }
 #endif
 
@@ -316,6 +365,6 @@ void MSG_task_set_priority(m_task_t task, double priority)
 
   task->simdata->priority = 1 / priority;
   if (task->simdata->compute)
-    SIMIX_req_host_execution_set_priority(task->simdata->compute,
+    simcall_host_execution_set_priority(task->simdata->compute,
                                       task->simdata->priority);
 }