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   return task;
  61 }
  62
  63 /** \ingroup m_task_management
  64  * \brief Return the user data of a #m_task_t.
  65  *
  66  * This functions checks whether \a task is a valid pointer or not and return
  67    the user data associated to \a task if it is possible.
  68  */
  69 void *MSG_task_get_data(m_task_t task)
  70 {
  71   xbt_assert0((task != NULL), "Invalid parameter");
  72
  73   return (task->data);
  74 }
  75
  76 /** \ingroup m_task_management
  77  * \brief Return the sender of a #m_task_t.
  78  *
  79  * This functions returns the #m_process_t which sent this task
  80  */
  81 m_process_t MSG_task_get_sender(m_task_t task)
  82 {
  83    xbt_assert0(task, "Invalid parameters");
  84    return ((simdata_task_t) task->simdata)->sender;
  85 }
  86
  87 /** \ingroup m_task_management
  88  * \brief Return the source of a #m_task_t.
  89  *
  90  * This functions returns the #m_host_t from which this task was sent
  91  */
  92 m_host_t MSG_task_get_source(m_task_t task)
  93 {
  94    xbt_assert0(task, "Invalid parameters");
  95    return ((simdata_task_t) task->simdata)->source;
  96 }
  97
  98 /** \ingroup m_task_management
  99  * \brief Return the name of a #m_task_t.
 100  *
 101  * This functions returns the name of a #m_task_t as specified on creation
 102  */
 103 const char *MSG_task_get_name(m_task_t task)
 104 {
 105    xbt_assert0(task, "Invalid parameters");
 106    return task->name;
 107 }
 108
 109
 110 /** \ingroup m_task_management
 111  * \brief Destroy a #m_task_t.
 112  *
 113  * Destructor for #m_task_t. Note that you should free user data, if any, \b
 114    before calling this function.
 115  */
 116 MSG_error_t MSG_task_destroy(m_task_t task)
 117 {
 118   smx_action_t action = NULL;
 119   xbt_assert0((task != NULL), "Invalid parameter");
 120
 121         /* 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 code wrong? */
 122   task->simdata->using--;
 123   if(task->simdata->using>0) return MSG_OK;
 124
 125   if(task->name) free(task->name);
 126
 127         SIMIX_cond_destroy(task->simdata->cond);
 128         SIMIX_mutex_destroy(task->simdata->mutex);
 129
 130   action = task->simdata->compute;
 131   if(action) SIMIX_action_destroy(action);
 132   action = task->simdata->comm;
 133   if(action) SIMIX_action_destroy(action);
 134         /* parallel tasks only */
 135   if(task->simdata->host_list) xbt_free(task->simdata->host_list);
 136
 137         /* free main structures */
 138         xbt_free(task->simdata);
 139         xbt_free(task);
 140
 141   return MSG_OK;
 142 }
 143
 144
 145 /** \ingroup m_task_management
 146  * \brief Cancel a #m_task_t.
 147  * \param task the taskt to cancel. If it was executed or transfered, it
 148           stops the process that were working on it.
 149  */
 150 MSG_error_t MSG_task_cancel(m_task_t task)
 151 {
 152   xbt_assert0((task != NULL), "Invalid parameter");
 153
 154   if(task->simdata->compute) {
 155                 SIMIX_action_cancel(task->simdata->compute);
 156     return MSG_OK;
 157   }
 158   if(task->simdata->comm) {
 159                 SIMIX_action_cancel(task->simdata->comm);
 160     return MSG_OK;
 161   }
 162
 163   return MSG_FATAL;
 164 }
 165
 166 /** \ingroup m_task_management
 167  * \brief Returns the computation amount needed to process a task #m_task_t.
 168  *        Once a task has been processed, this amount is thus set to 0...
 169  */
 170 double MSG_task_get_compute_duration(m_task_t task)
 171 {
 172   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 173
 174   return task->simdata->computation_amount;
 175 }
 176
 177 /** \ingroup m_task_management
 178  * \brief Returns the remaining computation amount of a task #m_task_t.
 179  *
 180  */
 181 double MSG_task_get_remaining_computation(m_task_t task)
 182 {
 183   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 184
 185   if(task->simdata->compute) {
 186     return SIMIX_action_get_remains(task->simdata->compute);
 187   } else {
 188     return task->simdata->computation_amount;
 189   }
 190 }
 191
 192 /** \ingroup m_task_management
 193  * \brief Returns the size of the data attached to a task #m_task_t.
 194  *
 195  */
 196 double MSG_task_get_data_size(m_task_t task)
 197 {
 198   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 199
 200   return task->simdata->message_size;
 201 }
 202
 203
 204
 205 /** \ingroup m_task_management
 206  * \brief Changes the priority of a computation task. This priority doesn't affect
 207  *        the transfer rate. A priority of 2 will make a task receive two times more
 208  *        cpu power than the other ones.
 209  *
 210  */
 211 void MSG_task_set_priority(m_task_t task, double priority)
 212 {
 213   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 214
 215   task->simdata->priority = 1/priority;
 216   if(task->simdata->compute)
 217                 SIMIX_action_set_priority(task->simdata->compute, task->simdata->priority);
 218 }
 219