2 #include "xbt/sysdep.h"
5 /** \defgroup m_task_management Managing functions of Tasks
6 * \brief This section describes the task structure of MSG
7 * (#m_task_t) and the functions for managing it.
8 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
10 * Since most scheduling algorithms rely on a concept of task
11 * that can be either <em>computed</em> locally or
12 * <em>transferred</em> on another processor, it seems to be the
13 * right level of abstraction for our purposes. A <em>task</em>
14 * may then be defined by a <em>computing amount</em>, a
15 * <em>message size</em> and some <em>private data</em>.
18 /********************************* Task **************************************/
19 /** \ingroup m_task_management
20 * \brief Creates a new #m_task_t.
22 * A constructor for #m_task_t taking four arguments and returning the
24 * \param name a name for the object. It is for user-level information
26 * \param compute_duration a value of the processing amount (in flop)
27 needed to process this new task. If 0, then it cannot be executed with
28 MSG_task_execute(). This value has to be >=0.
29 * \param message_size a value of the amount of data (in bytes) needed to
30 transfer this new task. If 0, then it cannot be transfered with
31 MSG_task_get() and MSG_task_put(). This value has to be >=0.
32 * \param data a pointer to any data may want to attach to the new
33 object. It is for user-level information and can be NULL. It can
34 be retrieved with the function \ref MSG_task_get_data.
36 * \return The new corresponding object.
38 m_task_t MSG_task_create(const char *name, double compute_duration,
39 double message_size, void *data)
41 m_task_t task = xbt_mallocator_get(msg_global->task_mallocator);
46 /** \ingroup m_task_management
47 * \brief Return the user data of a #m_task_t.
49 * This functions checks whether \a task is a valid pointer or not and return
50 the user data associated to \a task if it is possible.
52 void *MSG_task_get_data(m_task_t task)
54 xbt_assert0((task != NULL), "Invalid parameter");
59 /** \ingroup m_task_management
60 * \brief Return the sender of a #m_task_t.
62 * This functions returns the #m_process_t which sent this task
64 m_process_t MSG_task_get_sender(m_task_t task)
66 xbt_assert0(task, "Invalid parameters");
67 return ((simdata_task_t) task->simdata)->sender;
70 /** \ingroup m_task_management
71 * \brief Return the source of a #m_task_t.
73 * This functions returns the #m_host_t from which this task was sent
75 m_host_t MSG_task_get_source(m_task_t task)
77 xbt_assert0(task, "Invalid parameters");
78 return ((simdata_task_t) task->simdata)->source;
81 /** \ingroup m_task_management
82 * \brief Return the name of a #m_task_t.
84 * This functions returns the name of a #m_task_t as specified on creation
86 const char *MSG_task_get_name(m_task_t task)
88 xbt_assert0(task, "Invalid parameters");
93 /** \ingroup m_task_management
94 * \brief Destroy a #m_task_t.
96 * Destructor for #m_task_t. Note that you should free user data, if any, \b
97 before calling this function.
99 MSG_error_t MSG_task_destroy(m_task_t task)
105 /** \ingroup m_task_management
106 * \brief Cancel a #m_task_t.
107 * \param task the taskt to cancel. If it was executed or transfered, it
108 stops the process that were working on it.
110 MSG_error_t MSG_task_cancel(m_task_t task)
115 /** \ingroup m_task_management
116 * \brief Returns the computation amount needed to process a task #m_task_t.
117 * Once a task has been processed, this amount is thus set to 0...
119 double MSG_task_get_compute_duration(m_task_t task)
124 /** \ingroup m_task_management
125 * \brief Returns the remaining computation amount of a task #m_task_t.
128 double MSG_task_get_remaining_computation(m_task_t task)
133 /** \ingroup m_task_management
134 * \brief Returns the size of the data attached to a task #m_task_t.
137 double MSG_task_get_data_size(m_task_t task)
139 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
141 return task->simdata->message_size;
144 MSG_error_t __MSG_task_wait_event(m_process_t process, m_task_t task)
150 /** \ingroup m_task_management
151 * \brief Changes the priority of a computation task. This priority doesn't affect
152 * the transfer rate. A priority of 2 will make a task receive two times more
153 * cpu power than the other ones.
156 void MSG_task_set_priority(m_task_t task, double priority)
161 /* Mallocator functions */
162 m_task_t task_mallocator_new_f(void)
164 m_task_t task = xbt_new(s_m_task_t, 1);
165 simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
166 task->simdata = simdata;
170 void task_mallocator_free_f(m_task_t task)
172 xbt_assert0((task != NULL), "Invalid parameter");
174 xbt_free(task->simdata);
180 void task_mallocator_reset_f(m_task_t task)
182 memset(task->simdata, 0, sizeof(s_simdata_task_t));