src/msg/task.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "private.h"
   9 #include "xbt/sysdep.h"
  10 #include "xbt/log.h"
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(task, msg,
  12                                 "Logging specific to MSG (task)");
  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  *  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 Mflop)
  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 Mb) 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   simdata_task_t simdata = xbt_new0(s_simdata_task_t,1);
  50   m_task_t task = xbt_new0(s_m_task_t,1);
  51
  52   /* Task structure */
  53   task->name = xbt_strdup(name);
  54   task->simdata = simdata;
  55   task->data = data;
  56
  57   /* Simulator Data */
  58   simdata->sleeping = xbt_dynar_new(sizeof(m_process_t),NULL);
  59   simdata->computation_amount = compute_duration;
  60   simdata->message_size = message_size;
  61   simdata->rate = -1.0;
  62   simdata->priority = 1.0;
  63   simdata->using = 1;
  64   simdata->sender = NULL;
  65
  66   return task;
  67 }
  68
  69 /** \ingroup m_task_management
  70  * \brief Return the user data of a #m_task_t.
  71  *
  72  * This functions checks whether \a task is a valid pointer or not and return
  73    the user data associated to \a task if it is possible.
  74  */
  75 void *MSG_task_get_data(m_task_t task)
  76 {
  77   xbt_assert0((task != NULL), "Invalid parameter");
  78
  79   return (task->data);
  80 }
  81
  82 /** \ingroup m_task_management
  83  * \brief Return the sender of a #m_task_t.
  84  *
  85  * This functions returns the #m_process_t which sent this task
  86  */
  87 m_process_t MSG_task_get_sender(m_task_t task)
  88 {
  89    xbt_assert0(task, "Invalid parameters");
  90    return ((simdata_task_t) task->simdata)->sender;
  91 }
  92
  93 /** \ingroup m_task_management
  94  * \brief Return the source of a #m_task_t.
  95  *
  96  * This functions returns the #m_host_t from which this task was sent
  97  */
  98 m_host_t MSG_task_get_source(m_task_t task)
  99 {
 100    xbt_assert0(task, "Invalid parameters");
 101    return ((simdata_task_t) task->simdata)->source;
 102 }
 103
 104 /** \ingroup m_task_management
 105  * \brief Return the name of a #m_task_t.
 106  *
 107  * This functions returns the name of a #m_task_t as specified on creation
 108  */
 109 const char *MSG_task_get_name(m_task_t task)
 110 {
 111    xbt_assert0(task, "Invalid parameters");
 112    return task->name;
 113 }
 114
 115
 116 /** \ingroup m_task_management
 117  * \brief Destroy a #m_task_t.
 118  *
 119  * Destructor for #m_task_t. Note that you should free user data, if any, \b
 120    before calling this function.
 121  */
 122 MSG_error_t MSG_task_destroy(m_task_t task)
 123 {
 124   surf_action_t action = NULL;
 125
 126   xbt_assert0((task != NULL), "Invalid parameter");
 127
 128   task->simdata->using--;
 129   if(task->simdata->using>0) return MSG_OK;
 130
 131   xbt_assert0((xbt_dynar_length(task->simdata->sleeping)==0),
 132               "Task still used. There is a problem. Cannot destroy it now!");
 133
 134   if(task->name) free(task->name);
 135
 136   xbt_dynar_free(&(task->simdata->sleeping));
 137
 138   action = task->simdata->compute;
 139   if(action) action->resource_type->common_public->action_free(action);
 140   action = task->simdata->comm;
 141   if(action) action->resource_type->common_public->action_free(action);
 142   if(task->simdata->host_list) xbt_free(task->simdata->host_list);
 143
 144   free(task->simdata);
 145   free(task);
 146
 147   return MSG_OK;
 148 }
 149
 150
 151 /** \ingroup m_task_management
 152  * \brief Cancel a #m_task_t.
 153  * \param task the taskt to cancel. If it was executed or transfered, it
 154           stops the process that were working on it.
 155  */
 156 MSG_error_t MSG_task_cancel(m_task_t task)
 157 {
 158   xbt_assert0((task != NULL), "Invalid parameter");
 159
 160   if(task->simdata->compute) {
 161     surf_workstation_resource->common_public->action_cancel(task->simdata->compute);
 162     return MSG_OK;
 163   }
 164   if(task->simdata->comm) {
 165     surf_workstation_resource->common_public->action_cancel(task->simdata->comm);
 166     return MSG_OK;
 167   }
 168
 169   return MSG_FATAL;
 170 }
 171
 172 /** \ingroup m_task_management
 173  * \brief Returns the computation amount needed to process a task #m_task_t.
 174  *        Once a task has been processed, this amount is thus set to 0...
 175  */
 176 double MSG_task_get_compute_duration(m_task_t task) {
 177   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 178
 179   return task->simdata->computation_amount;
 180 }
 181
 182 /** \ingroup m_task_management
 183  * \brief Returns the remaining computation amount of a task #m_task_t.
 184  *
 185  */
 186 double MSG_task_get_remaining_computation(m_task_t task)
 187 {
 188   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 189
 190   if(task->simdata->compute) {
 191     return task->simdata->compute->remains;
 192   } else {
 193     return task->simdata->computation_amount;
 194   }
 195 }
 196
 197 /** \ingroup m_task_management
 198  * \brief Returns the size of the data attached to a task #m_task_t.
 199  *
 200  */
 201 double MSG_task_get_data_size(m_task_t task) {
 202   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 203
 204   return task->simdata->message_size;
 205 }
 206
 207 MSG_error_t __MSG_task_wait_event(m_process_t process, m_task_t task)
 208 {
 209   int _cursor;
 210   m_process_t proc = NULL;
 211
 212   xbt_assert0(((task != NULL)
 213                && (task->simdata != NULL)), "Invalid parameters");
 214
 215   xbt_dynar_push(task->simdata->sleeping, &process);
 216   process->simdata->waiting_task = task;
 217   xbt_context_yield();
 218   process->simdata->waiting_task = NULL;
 219   xbt_dynar_foreach(task->simdata->sleeping,_cursor,proc) {
 220     if(proc==process)
 221       xbt_dynar_remove_at(task->simdata->sleeping,_cursor,&proc);
 222   }
 223
 224   return MSG_OK;
 225 }
 226
 227
 228 /** \ingroup m_task_management
 229  * \brief Changes the priority of a computation task. This priority doesn't affect
 230  *        the transfer rate. A priority of 2 will make a task receive two times more
 231  *        cpu power than the other ones.
 232  *
 233  */
 234 void MSG_task_set_priority(m_task_t task, double priority) {
 235   xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
 236
 237   task->simdata->priority = 1/priority;
 238   if(task->simdata->compute)
 239     surf_workstation_resource->common_public->
 240       set_priority(task->simdata->compute, task->simdata->priority);
 241 }