src/msg/task.c

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