/* 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"private.h"
-#include"xbt/sysdep.h"
-#include "xbt/error.h"
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(task, msg,
- "Logging specific to MSG (task)");
-
-static char sprint_buffer[64];
+#include "private.h"
+#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.
+ * \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
+ * <em>transferred</em> on another processor, it seems to be the
+ * right level of abstraction for our purposes. A <em>task</em>
+ * may then be defined by a <em>computing amount</em>, a
+ * <em>message size</em> and some <em>private data</em>.
+ */
/********************************* Task **************************************/
/** \ingroup m_task_management
* \see m_task_t
* \return The new corresponding object.
*/
-m_task_t MSG_task_create(const char *name, long double compute_duration,
- long double message_size, void *data)
+m_task_t MSG_task_create(const char *name, double compute_duration,
+ double message_size, void *data)
{
simdata_task_t simdata = xbt_new0(s_simdata_task_t,1);
m_task_t task = xbt_new0(s_m_task_t,1);
simdata->sleeping = xbt_dynar_new(sizeof(m_process_t),NULL);
simdata->computation_amount = compute_duration;
simdata->message_size = message_size;
+ simdata->rate = -1.0;
+ simdata->priority = 1.0;
simdata->using = 1;
simdata->sender = NULL;
return (task->data);
}
+/** \ingroup m_task_management
+ * \brief Return the sender of a #m_task_t.
+ *
+ * This functions returns the #m_process_t which sent this task
+ */
+m_process_t MSG_task_get_sender(m_task_t task)
+{
+ xbt_assert0(task, "Invalid parameters");
+ return ((simdata_task_t) task->simdata)->sender;
+}
+
+/** \ingroup m_task_management
+ * \brief Return the source of a #m_task_t.
+ *
+ * This functions returns the #m_host_t from which this task was sent
+ */
+m_host_t MSG_task_get_source(m_task_t task)
+{
+ xbt_assert0(task, "Invalid parameters");
+ return ((simdata_task_t) task->simdata)->source;
+}
+
+/** \ingroup m_task_management
+ * \brief Return the name of a #m_task_t.
+ *
+ * This functions returns the name of a #m_task_t as specified on creation
+ */
+const char *MSG_task_get_name(m_task_t task)
+{
+ xbt_assert0(task, "Invalid parameters");
+ return task->name;
+}
+
+
/** \ingroup m_task_management
* \brief Destroy a #m_task_t.
*
*/
MSG_error_t MSG_task_destroy(m_task_t task)
{
- simdata_task_t simdata = NULL;
surf_action_t action = NULL;
- int i;
xbt_assert0((task != NULL), "Invalid parameter");
xbt_assert0((xbt_dynar_length(task->simdata->sleeping)==0),
"Task still used. There is a problem. Cannot destroy it now!");
- if(task->name) xbt_free(task->name);
+ if(task->name) free(task->name);
xbt_dynar_free(&(task->simdata->sleeping));
if(action) action->resource_type->common_public->action_free(action);
action = task->simdata->comm;
if(action) action->resource_type->common_public->action_free(action);
+ if(task->simdata->host_list) xbt_free(task->simdata->host_list);
-
- xbt_free(task->simdata);
- xbt_free(task);
+ free(task->simdata);
+ free(task);
return MSG_OK;
}
-/* static MSG_error_t __MSG_task_check(m_task_t task) */
-/* { */
-/* simdata_task_t simdata = NULL; */
-/* int warning = 0; */
-/* if (task == NULL) { /\* Fatal *\/ */
-/* WARNING("Task uninitialized"); */
-/* return MSG_FATAL; */
-/* } */
-/* simdata = task->simdata; */
-
-/* if (simdata == NULL) { /\* Fatal *\/ */
-/* WARNING("Simulator Data uninitialized"); */
-/* return MSG_FATAL; */
-/* } */
+/** \ingroup m_task_management
+ * \brief Cancel a #m_task_t.
+ * \param task the taskt 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");
-/* if (simdata->compute == NULL) { /\* Fatal if execute ... *\/ */
-/* WARNING("No duration set for this task"); */
-/* warning++; */
-/* } */
+ if(task->simdata->compute) {
+ surf_workstation_resource->common_public->action_cancel(task->simdata->compute);
+ return MSG_OK;
+ }
+ if(task->simdata->comm) {
+ surf_workstation_resource->common_public->action_cancel(task->simdata->comm);
+ return MSG_OK;
+ }
-/* if (simdata->message_size == 0) { /\* Fatal if transfered ... *\/ */
-/* WARNING("No message_size set for this task"); */
-/* warning++; */
-/* } */
+ return MSG_FATAL;
+}
-/* /\* if (task->data == NULL) { *\/ */
-/* /\* WARNING("User Data uninitialized"); *\/ */
-/* /\* warning++; *\/ */
-/* /\* } *\/ */
+/** \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) {
+ xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
-/* if (warning) */
-/* return MSG_WARNING; */
-/* return MSG_OK; */
-/* } */
+ return task->simdata->computation_amount;
+}
-/* static m_task_t __MSG_task_copy(m_task_t src) */
-/* { */
-/* m_task_t copy = NULL; */
-/* simdata_task_t simdata = NULL; */
+/** \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");
-/* __MSG_task_check(src); */
+ if(task->simdata->compute) {
+ return task->simdata->compute->remains;
+ } else {
+ return task->simdata->computation_amount;
+ }
+}
-/* simdata = src->simdata; */
-/* copy = MSG_task_create(src->name, SG_getTaskCost(simdata->compute), */
-/* simdata->message_size, MSG_task_get_data(src)); */
+/** \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) {
+ xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
-/* return (copy); */
-/* } */
+ return task->simdata->message_size;
+}
MSG_error_t __MSG_task_wait_event(m_process_t process, m_task_t task)
{
return MSG_OK;
}
+
+
+/** \ingroup m_task_management
+ * \brief Changes the priority of a computation task. This priority doesn't affect
+ * the transfer rate. A priority of 2 will make a task receive two times more
+ * cpu power than the other ones.
+ *
+ */
+void MSG_task_set_priority(m_task_t task, double priority) {
+ xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
+
+ task->simdata->priority = 1/priority;
+ if(task->simdata->compute)
+ surf_workstation_resource->common_public->
+ set_priority(task->simdata->compute, task->simdata->priority);
+}
