Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Started the gpu model by adding the MSG_gpu_task_create function, also added a simple...
[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 /*************** Begin GPU ***************/
82 /** \ingroup m_task_management
83  * \brief Creates a new #m_gpu_task_t.
84
85  * A constructor for #m_gpu_task_t taking four arguments and returning
86    a pointer to the new created GPU task.
87
88  * \param name a name for the object. It is for user-level information
89    and can be NULL.
90
91  * \param compute_duration a value of the processing amount (in flop)
92    needed to process this new task. If 0, then it cannot be executed with
93    MSG_gpu_task_execute(). This value has to be >=0.
94
95  * \param dispatch_latency time in seconds to load this task on the GPU
96
97  * \param collect_latency time in seconds to transfer result from the GPU
98    back to the CPU (host) when done
99
100  * \see m_gpu_task_t
101  * \return The new corresponding object.
102  */
103 m_gpu_task_t MSG_gpu_task_create(const char *name, double compute_duration,
104                          double dispatch_latency, double collect_latency)
105 {
106   m_gpu_task_t task = xbt_new(s_m_gpu_task_t, 1);
107   simdata_gpu_task_t simdata = xbt_new(s_simdata_gpu_task_t, 1);
108   task->simdata = simdata;
109   /* Task structure */
110   task->name = xbt_strdup(name);
111
112   /* Simulator Data */
113   simdata->computation_amount = compute_duration;
114   simdata->dispatch_latency   = dispatch_latency;
115   simdata->collect_latency    = collect_latency;
116
117 #ifdef HAVE_TRACING
118   //FIXME
119   TRACE_msg_gpu_task_create(task);
120 #endif
121
122   return task;
123 }
124 /*************** End GPU ***************/
125
126 /** \ingroup m_task_management
127  * \brief Return the user data of a #m_task_t.
128  *
129  * This function checks whether \a task is a valid pointer or not and return
130    the user data associated to \a task if it is possible.
131  */
132 void *MSG_task_get_data(m_task_t task)
133 {
134   xbt_assert((task != NULL), "Invalid parameter");
135
136   return (task->data);
137 }
138
139 /** \ingroup m_task_management
140  * \brief Sets the user data of a #m_task_t.
141  *
142  * This function allows to associate a new pointer to
143    the user data associated of \a task.
144  */
145 void MSG_task_set_data(m_task_t task, void *data)
146 {
147   xbt_assert((task != NULL), "Invalid parameter");
148
149   task->data = data;
150 }
151
152 /** \ingroup m_task_management
153  * \brief Sets a function to be called when a task has just been copied.
154  * \param callback a callback function
155  */
156 void MSG_task_set_copy_callback(void (*callback)
157     (m_task_t task, m_process_t sender, m_process_t receiver)) {
158
159   msg_global->task_copy_callback = callback;
160
161   if (callback) {
162     SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
163   }
164   else {
165     SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
166   }
167 }
168
169 /** \ingroup m_task_management
170  * \brief Return the sender of a #m_task_t.
171  *
172  * This functions returns the #m_process_t which sent this task
173  */
174 m_process_t MSG_task_get_sender(m_task_t task)
175 {
176   xbt_assert(task, "Invalid parameters");
177   return ((simdata_task_t) task->simdata)->sender;
178 }
179
180 /** \ingroup m_task_management
181  * \brief Return the source of a #m_task_t.
182  *
183  * This functions returns the #m_host_t from which this task was sent
184  */
185 m_host_t MSG_task_get_source(m_task_t task)
186 {
187   xbt_assert(task, "Invalid parameters");
188   return ((simdata_task_t) task->simdata)->source;
189 }
190
191 /** \ingroup m_task_management
192  * \brief Return the name of a #m_task_t.
193  *
194  * This functions returns the name of a #m_task_t as specified on creation
195  */
196 const char *MSG_task_get_name(m_task_t task)
197 {
198   xbt_assert(task, "Invalid parameters");
199   return task->name;
200 }
201
202 /** \ingroup m_task_management
203  * \brief Return the name of a #m_task_t.
204  *
205  * This functions allows to associate a name to a task
206  */
207 void MSG_task_set_name(m_task_t task, const char *name)
208 {
209   xbt_assert(task, "Invalid parameters");
210   task->name = xbt_strdup(name);
211 }
212
213 /** \ingroup m_task_management
214  * \brief Destroy a #m_task_t.
215  *
216  * Destructor for #m_task_t. Note that you should free user data, if any, \b 
217  * before calling this function.
218  *
219  * Only the process that owns the task can destroy it.
220  * The owner changes after a successful send.
221  * If a task is successfully sent, the receiver becomes the owner and is
222  * supposed to destroy it. The sender should not use it anymore.
223  * If the task failed to be sent, the sender remains the owner of the task.
224  */
225 MSG_error_t MSG_task_destroy(m_task_t task)
226 {
227   smx_action_t action = NULL;
228   xbt_assert((task != NULL), "Invalid parameter");
229
230   if (task->simdata->isused) {
231     /* the task is being sent or executed: cancel it first */
232     MSG_task_cancel(task);
233   }
234 #ifdef HAVE_TRACING
235   TRACE_msg_task_destroy(task);
236 #endif
237
238   xbt_free(task->name);
239
240   action = task->simdata->compute;
241   if (action)
242     simcall_host_execution_destroy(action);
243
244   /* parallel tasks only */
245   xbt_free(task->simdata->host_list);
246
247   /* free main structures */
248   xbt_free(task->simdata);
249   xbt_free(task);
250
251   return MSG_OK;
252 }
253
254
255 /** \ingroup m_task_management
256  * \brief Cancel a #m_task_t.
257  * \param task the task to cancel. If it was executed or transfered, it
258           stops the process that were working on it.
259  */
260 MSG_error_t MSG_task_cancel(m_task_t task)
261 {
262   xbt_assert((task != NULL), "Invalid parameter");
263
264   if (task->simdata->compute) {
265     simcall_host_execution_cancel(task->simdata->compute);
266   }
267   else if (task->simdata->comm) {
268     simcall_comm_cancel(task->simdata->comm);
269     task->simdata->isused = 0;
270   }
271   return MSG_OK;
272 }
273
274 /** \ingroup m_task_management
275  * \brief Returns the computation amount needed to process a task #m_task_t.
276  *        Once a task has been processed, this amount is thus set to 0...
277  */
278 double MSG_task_get_compute_duration(m_task_t task)
279 {
280   xbt_assert((task != NULL)
281               && (task->simdata != NULL), "Invalid parameter");
282
283   return task->simdata->computation_amount;
284 }
285
286
287 /** \ingroup m_task_management
288  * \brief set the computation amount needed to process a task #m_task_t.
289  */
290
291 void MSG_task_set_compute_duration(m_task_t task,
292                                    double computation_amount)
293 {
294   xbt_assert(task, "Invalid parameter");
295   task->simdata->computation_amount = computation_amount;
296
297 }
298
299 /** \ingroup m_task_management
300  * \brief Returns the remaining computation amount of a task #m_task_t.
301  *
302  */
303 double MSG_task_get_remaining_computation(m_task_t task)
304 {
305   xbt_assert((task != NULL)
306               && (task->simdata != NULL), "Invalid parameter");
307
308   if (task->simdata->compute) {
309     return simcall_host_execution_get_remains(task->simdata->compute);
310   } else {
311     return task->simdata->computation_amount;
312   }
313 }
314
315 /** \ingroup m_task_management
316  * \brief Returns the total amount received by a task #m_task_t.
317  *        If the communication does not exist it will return 0.
318  *        So, if the communication has FINISHED or FAILED it returns
319  *        zero.
320  */
321 double MSG_task_get_remaining_communication(m_task_t task)
322 {
323   xbt_assert((task != NULL)
324               && (task->simdata != NULL), "Invalid parameter");
325   XBT_DEBUG("calling simcall_communication_get_remains(%p)",
326          task->simdata->comm);
327   return simcall_comm_get_remains(task->simdata->comm);
328 }
329
330 #ifdef HAVE_LATENCY_BOUND_TRACKING
331 /** \ingroup m_task_management
332  * \brief Return 1 if communication task is limited by latency, 0 otherwise
333  *
334  */
335 int MSG_task_is_latency_bounded(m_task_t task)
336 {
337   xbt_assert((task != NULL)
338               && (task->simdata != NULL), "Invalid parameter");
339   XBT_DEBUG("calling simcall_communication_is_latency_bounded(%p)",
340          task->simdata->comm);
341   return simcall_comm_is_latency_bounded(task->simdata->comm);
342 }
343 #endif
344
345 /** \ingroup m_task_management
346  * \brief Returns the size of the data attached to a task #m_task_t.
347  *
348  */
349 double MSG_task_get_data_size(m_task_t task)
350 {
351   xbt_assert((task != NULL)
352               && (task->simdata != NULL), "Invalid parameter");
353
354   return task->simdata->message_size;
355 }
356
357
358
359 /** \ingroup m_task_management
360  * \brief Changes the priority of a computation task. This priority doesn't affect 
361  *        the transfer rate. A priority of 2 will make a task receive two times more
362  *        cpu power than the other ones.
363  *
364  */
365 void MSG_task_set_priority(m_task_t task, double priority)
366 {
367   xbt_assert((task != NULL)
368               && (task->simdata != NULL), "Invalid parameter");
369
370   task->simdata->priority = 1 / priority;
371   if (task->simdata->compute)
372     simcall_host_execution_set_priority(task->simdata->compute,
373                                       task->simdata->priority);
374 }