src/msg/task.c

   1 /*     $Id$      */
   2
   3 /* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
   4 /* Copyright (c) 2007 Bruno Donassolo.                                      */
   5 /* All rights reserved.                                                     */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include "msg/private.h"
  11 #include "xbt/sysdep.h"
  12 #include "xbt/log.h"
  13
  14 /** \defgroup m_task_management Managing functions of Tasks
  15  *  \brief This section describes the task structure of MSG
  16  *  (#m_task_t) and the functions for managing it.
  17  */
  18 /** @addtogroup m_task_management
  19  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
  20  *
  21  *  Since most scheduling algorithms rely on a concept of task
  22  *  that can be either <em>computed</em> locally or
  23  *  <em>transferred</em> on another processor, it seems to be the
  24  *  right level of abstraction for our purposes. A <em>task</em>
  25  *  may then be defined by a <em>computing amount</em>, a
  26  *  <em>message size</em> and some <em>private data</em>.
  27  */
  28
  29 /********************************* Task **************************************/
  30 /** \ingroup m_task_management
  31  * \brief Creates a new #m_task_t.
  32  *
  33  * A constructor for #m_task_t taking four arguments and returning the
  34    corresponding object.
  35  * \param name a name for the object. It is for user-level information
  36    and can be NULL.
  37  * \param compute_duration a value of the processing amount (in flop)
  38    needed to process this new task. If 0, then it cannot be executed with
  39    MSG_task_execute(). This value has to be >=0.
  40  * \param message_size a value of the amount of data (in bytes) needed to
  41    transfer this new task. If 0, then it cannot be transfered with
  42    MSG_task_get() and MSG_task_put(). This value has to be >=0.
  43  * \param data a pointer to any data may want to attach to the new
  44    object.  It is for user-level information and can be NULL. It can
  45    be retrieved with the function \ref MSG_task_get_data.
  46  * \see m_task_t
  47  * \return The new corresponding object.
  48  */
  49 m_task_t MSG_task_create(const char *name, double compute_duration,
  50                          double message_size, void *data)
  51 {
  52   m_task_t task = xbt_new(s_m_task_t, 1);
  53   simdata_task_t simdata = xbt_new(s_simdata_task_t, 1);
  54   task->simdata = simdata;
  55   /* Task structure */
  56   task->name = xbt_strdup(name);
  57   task->data = data;
  58
  59   /* Simulator Data */
  60   simdata->computation_amount = compute_duration;
  61   simdata->message_size = message_size;
  62   simdata->rate = -1.0;
  63   simdata->priority = 1.0;
  64   simdata->refcount = 1;
  65   simdata->sender = NULL;
  66   simdata->receiver = NULL;
  67   simdata->cond = SIMIX_cond_init();
  68   simdata->mutex = SIMIX_mutex_init();
  69   simdata->compute = NULL;
  70   simdata->comm = NULL;
  71
  72   simdata->host_list = NULL;
  73   simdata->comp_amount = NULL;
  74   simdata->comm_amount = NULL;
  75 #ifdef HAVE_TRACING
  76   TRACE_msg_task_create (task);
  77 #endif
  78
  79   return task;
  80 }
  81
  82 /** \ingroup m_task_management
  83  * \brief Return the user data of a #m_task_t.
  84  *
  85  * This function checks whether \a task is a valid pointer or not and return
  86    the user data associated to \a task if it is possible.
  87  */
  88 void *MSG_task_get_data(m_task_t task)
  89 {
  90   xbt_assert0((task != NULL), "Invalid parameter");
  91
  92   return (task->data);
  93 }
  94
  95 /** \ingroup m_task_management
  96  * \brief Sets the user data of a #m_task_t.
  97  *
  98  * This function allows to associate a new pointer to
  99    the user data associated of \a task.
 100  */
 101 void MSG_task_set_data(m_task_t task,void *data)
 102 {
 103   xbt_assert0((task != NULL), "Invalid parameter");
 104
 105   task->data = data;
 106 }
 107
 108 /** \ingroup m_task_management
 109  * \brief Return the sender of a #m_task_t.
 110  *
 111  * This functions returns the #m_process_t which sent this task
 112  */
 113 m_process_t MSG_task_get_sender(m_task_t task)
 114 {
 115   xbt_assert0(task, "Invalid parameters");
 116   return ((simdata_task_t) task->simdata)->sender;
 117 }
 118
 119 /** \ingroup m_task_management
 120  * \brief Return the source of a #m_task_t.
 121  *
 122  * This functions returns the #m_host_t from which this task was sent
 123  */
 124 m_host_t MSG_task_get_source(m_task_t task)
 125 {
 126   xbt_assert0(task, "Invalid parameters");
 127   return ((simdata_task_t) task->simdata)->source;
 128 }
 129
 130 /** \ingroup m_task_management
 131  * \brief Return the name of a #m_task_t.
 132  *
 133  * This functions returns the name of a #m_task_t as specified on creation
 134  */
 135 const char *MSG_task_get_name(m_task_t task)
 136 {
 137   xbt_assert0(task, "Invalid parameters");
 138   return task->name;
 139 }
 140
 141
 142 /** \ingroup m_task_management
 143  * \brief Destroy a #m_task_t.
 144  *
 145  * Destructor for #m_task_t. Note that you should free user data, if any, \b
 146    before calling this function.
 147  */
 148 MSG_error_t MSG_task_destroy(m_task_t task)
 149 {
 150   smx_action_t action = NULL;
 151   xbt_assert0((task != NULL), "Invalid parameter");
 152
 153   /* 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? */
 154   task->simdata->refcount--;
 155   if (task->simdata->refcount > 0)
 156     return MSG_OK;
 157 #ifdef HAVE_TRACING
 158   TRACE_msg_task_destroy (task);
 159 #endif
 160
 161   if (task->name)
 162     free(task->name);
 163
 164   SIMIX_cond_destroy(task->simdata->cond);
 165   SIMIX_mutex_destroy(task->simdata->mutex);
 166
 167   action = task->simdata->compute;
 168   if (action)
 169     SIMIX_action_destroy(action);
 170
 171   /* parallel tasks only */
 172   if (task->simdata->host_list)
 173     xbt_free(task->simdata->host_list);
 174
 175   /* free main structures */
 176   xbt_free(task->simdata);
 177   xbt_free(task);
 178
 179   return MSG_OK;
 180 }
 181
 182
 183 /** \ingroup m_task_management
 184  * \brief Cancel a #m_task_t.
 185  * \param task the taskt to cancel. If it was executed or transfered, it
 186           stops the process that were working on it.
 187  */
 188 MSG_error_t MSG_task_cancel(m_task_t task)
 189 {
 190   xbt_assert0((task != NULL), "Invalid parameter");
 191
 192   if (task->simdata->compute) {
 193     SIMIX_action_cancel(task->simdata->compute);
 194     return MSG_OK;
 195   }
 196   if (task->simdata->comm) {
 197     SIMIX_communication_cancel(task->simdata->comm);
 198     return MSG_OK;
 199   }
 200   THROW_IMPOSSIBLE;
 201 }
 202
 203 /** \ingroup m_task_management
 204  * \brief Returns the computation amount needed to process a task #m_task_t.
 205  *        Once a task has been processed, this amount is thus set to 0...
 206  */
 207 double MSG_task_get_compute_duration(m_task_t task)
 208 {
 209   xbt_assert0((task != NULL)
 210               && (task->simdata != NULL), "Invalid parameter");
 211
 212   return task->simdata->computation_amount;
 213 }
 214
 215 /** \ingroup m_task_management
 216  * \brief Returns the remaining computation amount of a task #m_task_t.
 217  *
 218  */
 219 double MSG_task_get_remaining_computation(m_task_t task)
 220 {
 221   xbt_assert0((task != NULL)
 222               && (task->simdata != NULL), "Invalid parameter");
 223
 224   if (task->simdata->compute) {
 225     return SIMIX_action_get_remains(task->simdata->compute);
 226   } else {
 227     return task->simdata->computation_amount;
 228   }
 229 }
 230
 231
 232
 233 /** \ingroup m_task_management
 234  * \brief Returns the total amount received by a task #m_task_t.
 235  *
 236  */
 237 double MSG_task_get_remaining_communication(m_task_t task)
 238 {
 239   xbt_assert0((task != NULL)
 240               && (task->simdata != NULL), "Invalid parameter");
 241
 242   return SIMIX_communication_get_remains(task->simdata->comm);
 243 }
 244
 245 /** \ingroup m_task_management
 246  * \brief Returns the size of the data attached to a task #m_task_t.
 247  *
 248  */
 249 double MSG_task_get_data_size(m_task_t task)
 250 {
 251   xbt_assert0((task != NULL)
 252               && (task->simdata != NULL), "Invalid parameter");
 253
 254   return task->simdata->message_size;
 255 }
 256
 257
 258
 259 /** \ingroup m_task_management
 260  * \brief Changes the priority of a computation task. This priority doesn't affect
 261  *        the transfer rate. A priority of 2 will make a task receive two times more
 262  *        cpu power than the other ones.
 263  *
 264  */
 265 void MSG_task_set_priority(m_task_t task, double priority)
 266 {
 267   xbt_assert0((task != NULL)
 268               && (task->simdata != NULL), "Invalid parameter");
 269
 270   task->simdata->priority = 1 / priority;
 271   if (task->simdata->compute)
 272     SIMIX_action_set_priority(task->simdata->compute,
 273                               task->simdata->priority);
 274 }
 275
 276