1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "msg/private.h"
8 #include "xbt/sysdep.h"
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.
15 /** @addtogroup m_task_management
16 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
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>.
26 /********************************* Task **************************************/
27 /** \ingroup m_task_management
28 * \brief Creates a new #m_task_t.
30 * A constructor for #m_task_t taking four arguments and returning the
32 * \param name a name for the object. It is for user-level information
34 * \param compute_duration a value of the processing amount (in flop)
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 bytes) 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.
44 * \return The new corresponding object.
46 m_task_t MSG_task_create(const char *name, double compute_duration,
47 double message_size, void *data)
49 m_task_t task = xbt_new(s_m_task_t, 1);
50 simdata_task_t simdata = xbt_new(s_simdata_task_t, 1);
51 task->simdata = simdata;
53 task->name = xbt_strdup(name);
58 simdata->computation_amount = compute_duration;
59 simdata->message_size = message_size;
61 simdata->priority = 1.0;
62 simdata->refcount = 1;
63 simdata->sender = NULL;
64 simdata->receiver = NULL;
65 simdata->cond = SIMIX_cond_init();
66 simdata->mutex = SIMIX_mutex_init();
67 simdata->compute = NULL;
70 simdata->host_list = NULL;
71 simdata->comp_amount = NULL;
72 simdata->comm_amount = NULL;
74 TRACE_msg_task_create (task);
80 /** \ingroup m_task_management
81 * \brief Return the user data of a #m_task_t.
83 * This function checks whether \a task is a valid pointer or not and return
84 the user data associated to \a task if it is possible.
86 void *MSG_task_get_data(m_task_t task)
88 xbt_assert0((task != NULL), "Invalid parameter");
93 /** \ingroup m_task_management
94 * \brief Sets the user data of a #m_task_t.
96 * This function allows to associate a new pointer to
97 the user data associated of \a task.
99 void MSG_task_set_data(m_task_t task,void *data)
101 xbt_assert0((task != NULL), "Invalid parameter");
106 /** \ingroup m_task_management
107 * \brief Return the sender of a #m_task_t.
109 * This functions returns the #m_process_t which sent this task
111 m_process_t MSG_task_get_sender(m_task_t task)
113 xbt_assert0(task, "Invalid parameters");
114 return ((simdata_task_t) task->simdata)->sender;
117 /** \ingroup m_task_management
118 * \brief Return the source of a #m_task_t.
120 * This functions returns the #m_host_t from which this task was sent
122 m_host_t MSG_task_get_source(m_task_t task)
124 xbt_assert0(task, "Invalid parameters");
125 return ((simdata_task_t) task->simdata)->source;
128 /** \ingroup m_task_management
129 * \brief Return the name of a #m_task_t.
131 * This functions returns the name of a #m_task_t as specified on creation
133 const char *MSG_task_get_name(m_task_t task)
135 xbt_assert0(task, "Invalid parameters");
140 /** \ingroup m_task_management
141 * \brief Destroy a #m_task_t.
143 * Destructor for #m_task_t. Note that you should free user data, if any, \b
144 before calling this function.
146 MSG_error_t MSG_task_destroy(m_task_t task)
148 smx_action_t action = NULL;
149 xbt_assert0((task != NULL), "Invalid parameter");
151 /* 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? */
152 task->simdata->refcount--;
153 if (task->simdata->refcount > 0)
156 TRACE_msg_task_destroy (task);
162 SIMIX_cond_destroy(task->simdata->cond);
163 SIMIX_mutex_destroy(task->simdata->mutex);
165 action = task->simdata->compute;
167 SIMIX_action_destroy(action);
169 /* parallel tasks only */
170 if (task->simdata->host_list)
171 xbt_free(task->simdata->host_list);
173 /* free main structures */
174 xbt_free(task->simdata);
181 /** \ingroup m_task_management
182 * \brief Cancel a #m_task_t.
183 * \param task the taskt to cancel. If it was executed or transfered, it
184 stops the process that were working on it.
186 MSG_error_t MSG_task_cancel(m_task_t task)
188 xbt_assert0((task != NULL), "Invalid parameter");
190 if (task->simdata->compute) {
191 SIMIX_action_cancel(task->simdata->compute);
194 if (task->simdata->comm) {
195 SIMIX_communication_cancel(task->simdata->comm);
201 /** \ingroup m_task_management
202 * \brief Returns the computation amount needed to process a task #m_task_t.
203 * Once a task has been processed, this amount is thus set to 0...
205 double MSG_task_get_compute_duration(m_task_t task)
207 xbt_assert0((task != NULL)
208 && (task->simdata != NULL), "Invalid parameter");
210 return task->simdata->computation_amount;
213 /** \ingroup m_task_management
214 * \brief Returns the remaining computation amount of a task #m_task_t.
217 double MSG_task_get_remaining_computation(m_task_t task)
219 xbt_assert0((task != NULL)
220 && (task->simdata != NULL), "Invalid parameter");
222 if (task->simdata->compute) {
223 return SIMIX_action_get_remains(task->simdata->compute);
225 return task->simdata->computation_amount;
231 /** \ingroup m_task_management
232 * \brief Returns the total amount received by a task #m_task_t.
235 double MSG_task_get_remaining_communication(m_task_t task)
237 xbt_assert0((task != NULL)
238 && (task->simdata != NULL), "Invalid parameter");
240 return SIMIX_communication_get_remains(task->simdata->comm);
243 /** \ingroup m_task_management
244 * \brief Returns the size of the data attached to a task #m_task_t.
247 double MSG_task_get_data_size(m_task_t task)
249 xbt_assert0((task != NULL)
250 && (task->simdata != NULL), "Invalid parameter");
252 return task->simdata->message_size;
257 /** \ingroup m_task_management
258 * \brief Changes the priority of a computation task. This priority doesn't affect
259 * the transfer rate. A priority of 2 will make a task receive two times more
260 * cpu power than the other ones.
263 void MSG_task_set_priority(m_task_t task, double priority)
265 xbt_assert0((task != NULL)
266 && (task->simdata != NULL), "Invalid parameter");
268 task->simdata->priority = 1 / priority;
269 if (task->simdata->compute)
270 SIMIX_action_set_priority(task->simdata->compute,
271 task->simdata->priority);