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 #ifdef HAVE_RUBY                /* FIXME: KILLME */
  27 XBT_LOG_EXTERNAL_CATEGORY(ruby);
  28 #endif
  29
  30
  31
  32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg,
  33                                 "Logging specific to MSG (task)");
  34
  35 /********************************* Task **************************************/
  36 /** \ingroup m_task_management
  37  * \brief Creates a new #m_task_t.
  38  *
  39  * A constructor for #m_task_t taking four arguments and returning the
  40    corresponding object.
  41  * \param name a name for the object. It is for user-level information
  42    and can be NULL.
  43  * \param compute_duration a value of the processing amount (in flop)
  44    needed to process this new task. If 0, then it cannot be executed with
  45    MSG_task_execute(). This value has to be >=0.
  46  * \param message_size a value of the amount of data (in bytes) needed to
  47    transfer this new task. If 0, then it cannot be transfered with
  48    MSG_task_get() and MSG_task_put(). This value has to be >=0.
  49  * \param data a pointer to any data may want to attach to the new
  50    object.  It is for user-level information and can be NULL. It can
  51    be retrieved with the function \ref MSG_task_get_data.
  52  * \see m_task_t
  53  * \return The new corresponding object.
  54  */
  55 m_task_t MSG_task_create(const char *name, double compute_duration,
  56                          double message_size, void *data)
  57 {
  58   m_task_t task = xbt_new(s_m_task_t, 1);
  59   simdata_task_t simdata = xbt_new(s_simdata_task_t, 1);
  60   task->simdata = simdata;
  61   /* Task structure */
  62   task->name = xbt_strdup(name);
  63   task->data = data;
  64
  65   /* Simulator Data */
  66   simdata->host_nb = 0;
  67   simdata->computation_amount = compute_duration;
  68   simdata->message_size = message_size;
  69   simdata->rate = -1.0;
  70   simdata->priority = 1.0;
  71   simdata->refcount = 1;
  72   simdata->sender = NULL;
  73   simdata->receiver = NULL;
  74   simdata->compute = NULL;
  75   simdata->comm = NULL;
  76
  77   simdata->host_list = NULL;
  78   simdata->comp_amount = NULL;
  79   simdata->comm_amount = NULL;
  80 #ifdef HAVE_TRACING
  81   TRACE_msg_task_create(task);
  82 #endif
  83
  84   return task;
  85 }
  86
  87 /** \ingroup m_task_management
  88  * \brief Return the user data of a #m_task_t.
  89  *
  90  * This function checks whether \a task is a valid pointer or not and return
  91    the user data associated to \a task if it is possible.
  92  */
  93 void *MSG_task_get_data(m_task_t task)
  94 {
  95   xbt_assert0((task != NULL), "Invalid parameter");
  96
  97   return (task->data);
  98 }
  99
 100 /** \ingroup m_task_management
 101  * \brief Sets the user data of a #m_task_t.
 102  *
 103  * This function allows to associate a new pointer to
 104    the user data associated of \a task.
 105  */
 106 void MSG_task_set_data(m_task_t task, void *data)
 107 {
 108   xbt_assert0((task != NULL), "Invalid parameter");
 109
 110   task->data = data;
 111 }
 112
 113 /** \ingroup m_task_management
 114  * \brief Return the sender of a #m_task_t.
 115  *
 116  * This functions returns the #m_process_t which sent this task
 117  */
 118 m_process_t MSG_task_get_sender(m_task_t task)
 119 {
 120   xbt_assert0(task, "Invalid parameters");
 121   return ((simdata_task_t) task->simdata)->sender;
 122 }
 123
 124 /** \ingroup m_task_management
 125  * \brief Return the source of a #m_task_t.
 126  *
 127  * This functions returns the #m_host_t from which this task was sent
 128  */
 129 m_host_t MSG_task_get_source(m_task_t task)
 130 {
 131   xbt_assert0(task, "Invalid parameters");
 132   return ((simdata_task_t) task->simdata)->source;
 133 }
 134
 135 /** \ingroup m_task_management
 136  * \brief Return the name of a #m_task_t.
 137  *
 138  * This functions returns the name of a #m_task_t as specified on creation
 139  */
 140 const char *MSG_task_get_name(m_task_t task)
 141 {
 142   xbt_assert0(task, "Invalid parameters");
 143   return task->name;
 144 }
 145
 146 /** \ingroup m_task_management
 147  * \brief Return the name of a #m_task_t.
 148  *
 149  * This functions allows to associate a name to a task
 150  */
 151 void MSG_task_set_name(m_task_t task, const char *name)
 152 {
 153   xbt_assert0(task, "Invalid parameters");
 154   task->name = xbt_strdup(name);
 155 }
 156
 157
 158 void MSG_task_refcount_dec(m_task_t task)
 159 {
 160   task->simdata->refcount--;
 161 }
 162
 163 /** \ingroup m_task_management
 164  * \brief Destroy a #m_task_t.
 165  *
 166  * Destructor for #m_task_t. Note that you should free user data, if any, \b
 167    before calling this function.
 168  */
 169 MSG_error_t MSG_task_destroy(m_task_t task)
 170 {
 171   smx_action_t action = NULL;
 172   xbt_assert0((task != NULL), "Invalid parameter");
 173
 174   /* 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? */
 175   task->simdata->refcount--;
 176   if (task->simdata->refcount > 0)
 177     return MSG_OK;
 178 #ifdef HAVE_TRACING
 179   TRACE_msg_task_destroy(task);
 180 #endif
 181
 182   if (task->name)
 183     free(task->name);
 184
 185   action = task->simdata->compute;
 186   if (action)
 187     SIMIX_req_host_execution_destroy(action);
 188
 189   /* parallel tasks only */
 190   if (task->simdata->host_list)
 191     xbt_free(task->simdata->host_list);
 192
 193   /* free main structures */
 194   xbt_free(task->simdata);
 195   xbt_free(task);
 196
 197   return MSG_OK;
 198 }
 199
 200
 201 /** \ingroup m_task_management
 202  * \brief Cancel a #m_task_t.
 203  * \param task the taskt to cancel. If it was executed or transfered, it
 204           stops the process that were working on it.
 205  */
 206 MSG_error_t MSG_task_cancel(m_task_t task)
 207 {
 208   xbt_assert0((task != NULL), "Invalid parameter");
 209
 210   if (task->simdata->compute) {
 211     SIMIX_req_host_execution_cancel(task->simdata->compute);
 212     return MSG_OK;
 213   }
 214   if (task->simdata->comm) {
 215     SIMIX_req_comm_cancel(task->simdata->comm);
 216     return MSG_OK;
 217   }
 218   THROW_IMPOSSIBLE;
 219 }
 220
 221 /** \ingroup m_task_management
 222  * \brief Returns the computation amount needed to process a task #m_task_t.
 223  *        Once a task has been processed, this amount is thus set to 0...
 224  */
 225 double MSG_task_get_compute_duration(m_task_t task)
 226 {
 227   xbt_assert0((task != NULL)
 228               && (task->simdata != NULL), "Invalid parameter");
 229
 230   return task->simdata->computation_amount;
 231 }
 232
 233
 234 /** \ingroup m_task_management
 235  * \brief set the computation amount needed to process a task #m_task_t.
 236  */
 237
 238 void MSG_task_set_compute_duration(m_task_t task,
 239                                    double computation_amount)
 240 {
 241   xbt_assert0(task, "Invalid parameter");
 242   task->simdata->computation_amount = computation_amount;
 243
 244 }
 245
 246 /** \ingroup m_task_management
 247  * \brief Returns the remaining computation amount of a task #m_task_t.
 248  *
 249  */
 250 double MSG_task_get_remaining_computation(m_task_t task)
 251 {
 252   xbt_assert0((task != NULL)
 253               && (task->simdata != NULL), "Invalid parameter");
 254
 255   if (task->simdata->compute) {
 256     return SIMIX_req_host_execution_get_remains(task->simdata->compute);
 257   } else {
 258     return task->simdata->computation_amount;
 259   }
 260 }
 261
 262 /** \ingroup m_task_management
 263  * \brief Returns the total amount received by a task #m_task_t.
 264  *        If the communication does not exist it will return 0.
 265  *        So, if the communication has FINISHED or FAILED it returns
 266  *        zero.
 267  */
 268 double MSG_task_get_remaining_communication(m_task_t task)
 269 {
 270   xbt_assert0((task != NULL)
 271               && (task->simdata != NULL), "Invalid parameter");
 272   DEBUG1("calling SIMIX_req_communication_get_remains(%p)",
 273          task->simdata->comm);
 274   return SIMIX_req_comm_get_remains(task->simdata->comm);
 275 }
 276
 277 #ifdef HAVE_LATENCY_BOUND_TRACKING
 278 /** \ingroup m_task_management
 279  * \brief Return 1 if communication task is limited by latency, 0 otherwise
 280  *
 281  */
 282 int MSG_task_is_latency_bounded(m_task_t task)
 283 {
 284   xbt_assert0((task != NULL)
 285               && (task->simdata != NULL), "Invalid parameter");
 286   DEBUG1("calling SIMIX_req_communication_is_latency_bounded(%p)",
 287          task->simdata->comm);
 288   return SIMIX_req_comm_is_latency_bounded(task->simdata->comm);
 289 }
 290 #endif
 291
 292 /** \ingroup m_task_management
 293  * \brief Returns the size of the data attached to a task #m_task_t.
 294  *
 295  */
 296 double MSG_task_get_data_size(m_task_t task)
 297 {
 298   xbt_assert0((task != NULL)
 299               && (task->simdata != NULL), "Invalid parameter");
 300
 301   return task->simdata->message_size;
 302 }
 303
 304
 305
 306 /** \ingroup m_task_management
 307  * \brief Changes the priority of a computation task. This priority doesn't affect
 308  *        the transfer rate. A priority of 2 will make a task receive two times more
 309  *        cpu power than the other ones.
 310  *
 311  */
 312 void MSG_task_set_priority(m_task_t task, double priority)
 313 {
 314   xbt_assert0((task != NULL)
 315               && (task->simdata != NULL), "Invalid parameter");
 316
 317   task->simdata->priority = 1 / priority;
 318   if (task->simdata->compute)
 319     SIMIX_req_host_execution_set_priority(task->simdata->compute,
 320                                       task->simdata->priority);
 321 }