src/msg_simix/msg_simix_task.c

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