Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Clean MSG source file names
[simgrid.git] / src / msg / 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 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg,
27                                 "Logging specific to MSG (task)");
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->host_nb = 0;
61   simdata->computation_amount = compute_duration;
62   simdata->message_size = message_size;
63   simdata->rate = -1.0;
64   simdata->priority = 1.0;
65   simdata->isused = 0;
66   simdata->sender = NULL;
67   simdata->receiver = NULL;
68   simdata->compute = NULL;
69   simdata->comm = NULL;
70
71   simdata->host_list = NULL;
72   simdata->comp_amount = NULL;
73   simdata->comm_amount = NULL;
74 #ifdef HAVE_TRACING
75   TRACE_msg_task_create(task);
76 #endif
77
78   return task;
79 }
80
81 /** \ingroup m_task_management
82  * \brief Return the user data of a #m_task_t.
83  *
84  * This function checks whether \a task is a valid pointer or not and return
85    the user data associated to \a task if it is possible.
86  */
87 void *MSG_task_get_data(m_task_t task)
88 {
89   xbt_assert((task != NULL), "Invalid parameter");
90
91   return (task->data);
92 }
93
94 /** \ingroup m_task_management
95  * \brief Sets the user data of a #m_task_t.
96  *
97  * This function allows to associate a new pointer to
98    the user data associated of \a task.
99  */
100 void MSG_task_set_data(m_task_t task, void *data)
101 {
102   xbt_assert((task != NULL), "Invalid parameter");
103
104   task->data = data;
105 }
106
107 /** \ingroup m_task_management
108  * \brief Return the sender of a #m_task_t.
109  *
110  * This functions returns the #m_process_t which sent this task
111  */
112 m_process_t MSG_task_get_sender(m_task_t task)
113 {
114   xbt_assert(task, "Invalid parameters");
115   return ((simdata_task_t) task->simdata)->sender;
116 }
117
118 /** \ingroup m_task_management
119  * \brief Return the source of a #m_task_t.
120  *
121  * This functions returns the #m_host_t from which this task was sent
122  */
123 m_host_t MSG_task_get_source(m_task_t task)
124 {
125   xbt_assert(task, "Invalid parameters");
126   return ((simdata_task_t) task->simdata)->source;
127 }
128
129 /** \ingroup m_task_management
130  * \brief Return the name of a #m_task_t.
131  *
132  * This functions returns the name of a #m_task_t as specified on creation
133  */
134 const char *MSG_task_get_name(m_task_t task)
135 {
136   xbt_assert(task, "Invalid parameters");
137   return task->name;
138 }
139
140 /** \ingroup m_task_management
141  * \brief Return the name of a #m_task_t.
142  *
143  * This functions allows to associate a name to a task
144  */
145 void MSG_task_set_name(m_task_t task, const char *name)
146 {
147   xbt_assert(task, "Invalid parameters");
148   task->name = xbt_strdup(name);
149 }
150
151 /** \ingroup m_task_management
152  * \brief Destroy a #m_task_t.
153  *
154  * Destructor for #m_task_t. Note that you should free user data, if any, \b 
155  * before calling this function.
156  *
157  * Only the process that owns the task can destroy it.
158  * The owner changes after a successful send.
159  * If a task is successfully sent, the receiver becomes the owner and is
160  * supposed to destroy it. The sender should not use it anymore.
161  * If the task failed to be sent, the sender remains the owner of the task.
162  */
163 MSG_error_t MSG_task_destroy(m_task_t task)
164 {
165   smx_action_t action = NULL;
166   xbt_assert((task != NULL), "Invalid parameter");
167
168   if (task->simdata->isused) {
169     /* the task is being sent or executed: cancel it first */
170     MSG_task_cancel(task);
171   }
172 #ifdef HAVE_TRACING
173   TRACE_msg_task_destroy(task);
174 #endif
175
176   xbt_free(task->name);
177
178   action = task->simdata->compute;
179   if (action)
180     SIMIX_req_host_execution_destroy(action);
181
182   /* parallel tasks only */
183   xbt_free(task->simdata->host_list);
184
185   /* free main structures */
186   xbt_free(task->simdata);
187   xbt_free(task);
188
189   return MSG_OK;
190 }
191
192
193 /** \ingroup m_task_management
194  * \brief Cancel a #m_task_t.
195  * \param task the task to cancel. If it was executed or transfered, it
196           stops the process that were working on it.
197  */
198 MSG_error_t MSG_task_cancel(m_task_t task)
199 {
200   xbt_assert((task != NULL), "Invalid parameter");
201
202   if (task->simdata->compute) {
203     SIMIX_req_host_execution_cancel(task->simdata->compute);
204   }
205   else if (task->simdata->comm) {
206     SIMIX_req_comm_cancel(task->simdata->comm);
207     task->simdata->isused = 0;
208   }
209   return MSG_OK;
210 }
211
212 /** \ingroup m_task_management
213  * \brief Returns the computation amount needed to process a task #m_task_t.
214  *        Once a task has been processed, this amount is thus set to 0...
215  */
216 double MSG_task_get_compute_duration(m_task_t task)
217 {
218   xbt_assert((task != NULL)
219               && (task->simdata != NULL), "Invalid parameter");
220
221   return task->simdata->computation_amount;
222 }
223
224
225 /** \ingroup m_task_management
226  * \brief set the computation amount needed to process a task #m_task_t.
227  */
228
229 void MSG_task_set_compute_duration(m_task_t task,
230                                    double computation_amount)
231 {
232   xbt_assert(task, "Invalid parameter");
233   task->simdata->computation_amount = computation_amount;
234
235 }
236
237 /** \ingroup m_task_management
238  * \brief Returns the remaining computation amount of a task #m_task_t.
239  *
240  */
241 double MSG_task_get_remaining_computation(m_task_t task)
242 {
243   xbt_assert((task != NULL)
244               && (task->simdata != NULL), "Invalid parameter");
245
246   if (task->simdata->compute) {
247     return SIMIX_req_host_execution_get_remains(task->simdata->compute);
248   } else {
249     return task->simdata->computation_amount;
250   }
251 }
252
253 /** \ingroup m_task_management
254  * \brief Returns the total amount received by a task #m_task_t.
255  *        If the communication does not exist it will return 0.
256  *        So, if the communication has FINISHED or FAILED it returns
257  *        zero.
258  */
259 double MSG_task_get_remaining_communication(m_task_t task)
260 {
261   xbt_assert((task != NULL)
262               && (task->simdata != NULL), "Invalid parameter");
263   XBT_DEBUG("calling SIMIX_req_communication_get_remains(%p)",
264          task->simdata->comm);
265   return SIMIX_req_comm_get_remains(task->simdata->comm);
266 }
267
268 #ifdef HAVE_LATENCY_BOUND_TRACKING
269 /** \ingroup m_task_management
270  * \brief Return 1 if communication task is limited by latency, 0 otherwise
271  *
272  */
273 int MSG_task_is_latency_bounded(m_task_t task)
274 {
275   xbt_assert((task != NULL)
276               && (task->simdata != NULL), "Invalid parameter");
277   XBT_DEBUG("calling SIMIX_req_communication_is_latency_bounded(%p)",
278          task->simdata->comm);
279   return SIMIX_req_comm_is_latency_bounded(task->simdata->comm);
280 }
281 #endif
282
283 /** \ingroup m_task_management
284  * \brief Returns the size of the data attached to a task #m_task_t.
285  *
286  */
287 double MSG_task_get_data_size(m_task_t task)
288 {
289   xbt_assert((task != NULL)
290               && (task->simdata != NULL), "Invalid parameter");
291
292   return task->simdata->message_size;
293 }
294
295
296
297 /** \ingroup m_task_management
298  * \brief Changes the priority of a computation task. This priority doesn't affect 
299  *        the transfer rate. A priority of 2 will make a task receive two times more
300  *        cpu power than the other ones.
301  *
302  */
303 void MSG_task_set_priority(m_task_t task, double priority)
304 {
305   xbt_assert((task != NULL)
306               && (task->simdata != NULL), "Invalid parameter");
307
308   task->simdata->priority = 1 / priority;
309   if (task->simdata->compute)
310     SIMIX_req_host_execution_set_priority(task->simdata->compute,
311                                       task->simdata->priority);
312 }