Logo AND Algorithmique Numérique Distribuée

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