3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "xbt/sysdep.h"
12 /** \defgroup m_task_management Managing functions of Tasks
13 * \brief This section describes the task structure of MSG
14 * (#m_task_t) and the functions for managing it.
15 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
17 * Since most scheduling algorithms rely on a concept of task
18 * that can be either <em>computed</em> locally or
19 * <em>transferred</em> on another processor, it seems to be the
20 * right level of abstraction for our purposes. A <em>task</em>
21 * may then be defined by a <em>computing amount</em>, a
22 * <em>message size</em> and some <em>private data</em>.
25 /********************************* Task **************************************/
26 /** \ingroup m_task_management
27 * \brief Creates a new #m_task_t.
29 * A constructor for #m_task_t taking four arguments and returning the
31 * \param name a name for the object. It is for user-level information
33 * \param compute_duration a value of the processing amount (in Mflop)
34 needed to process this new task. If 0, then it cannot be executed with
35 MSG_task_execute(). This value has to be >=0.
36 * \param message_size a value of the amount of data (in Mb) needed to
37 transfer this new task. If 0, then it cannot be transfered with
38 MSG_task_get() and MSG_task_put(). This value has to be >=0.
39 * \param data a pointer to any data may want to attach to the new
40 object. It is for user-level information and can be NULL. It can
41 be retrieved with the function \ref MSG_task_get_data.
43 * \return The new corresponding object.
45 m_task_t MSG_task_create(const char *name, double compute_duration,
46 double message_size, void *data)
48 m_task_t task = xbt_mallocator_get(msg_global->task_mallocator);
49 simdata_task_t simdata = task->simdata;
52 task->name = xbt_strdup(name);
56 simdata->sleeping = xbt_dynar_new(sizeof(m_process_t),NULL);
57 simdata->computation_amount = compute_duration;
58 simdata->message_size = message_size;
60 simdata->priority = 1.0;
62 simdata->sender = NULL;
67 /** \ingroup m_task_management
68 * \brief Return the user data of a #m_task_t.
70 * This functions checks whether \a task is a valid pointer or not and return
71 the user data associated to \a task if it is possible.
73 void *MSG_task_get_data(m_task_t task)
75 xbt_assert0((task != NULL), "Invalid parameter");
80 /** \ingroup m_task_management
81 * \brief Return the sender of a #m_task_t.
83 * This functions returns the #m_process_t which sent this task
85 m_process_t MSG_task_get_sender(m_task_t task)
87 xbt_assert0(task, "Invalid parameters");
88 return ((simdata_task_t) task->simdata)->sender;
91 /** \ingroup m_task_management
92 * \brief Return the source of a #m_task_t.
94 * This functions returns the #m_host_t from which this task was sent
96 m_host_t MSG_task_get_source(m_task_t task)
98 xbt_assert0(task, "Invalid parameters");
99 return ((simdata_task_t) task->simdata)->source;
102 /** \ingroup m_task_management
103 * \brief Return the name of a #m_task_t.
105 * This functions returns the name of a #m_task_t as specified on creation
107 const char *MSG_task_get_name(m_task_t task)
109 xbt_assert0(task, "Invalid parameters");
114 /** \ingroup m_task_management
115 * \brief Destroy a #m_task_t.
117 * Destructor for #m_task_t. Note that you should free user data, if any, \b
118 before calling this function.
120 MSG_error_t MSG_task_destroy(m_task_t task)
122 surf_action_t action = NULL;
123 xbt_assert0((task != NULL), "Invalid parameter");
125 task->simdata->using--;
126 if(task->simdata->using>0) return MSG_OK;
128 xbt_assert0((xbt_dynar_length(task->simdata->sleeping)==0),
129 "Task still used. There is a problem. Cannot destroy it now!");
131 if(task->name) free(task->name);
133 xbt_dynar_free(&(task->simdata->sleeping));
135 action = task->simdata->compute;
136 if(action) action->resource_type->common_public->action_free(action);
137 action = task->simdata->comm;
138 if(action) action->resource_type->common_public->action_free(action);
139 if(task->simdata->host_list) xbt_free(task->simdata->host_list);
141 xbt_mallocator_release(msg_global->task_mallocator, task);
146 /** \ingroup m_task_management
147 * \brief Cancel a #m_task_t.
148 * \param task the taskt to cancel. If it was executed or transfered, it
149 stops the process that were working on it.
151 MSG_error_t MSG_task_cancel(m_task_t task)
153 xbt_assert0((task != NULL), "Invalid parameter");
155 if(task->simdata->compute) {
156 surf_workstation_resource->common_public->action_cancel(task->simdata->compute);
159 if(task->simdata->comm) {
160 surf_workstation_resource->common_public->action_cancel(task->simdata->comm);
167 /** \ingroup m_task_management
168 * \brief Returns the computation amount needed to process a task #m_task_t.
169 * Once a task has been processed, this amount is thus set to 0...
171 double MSG_task_get_compute_duration(m_task_t task) {
172 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
174 return task->simdata->computation_amount;
177 /** \ingroup m_task_management
178 * \brief Returns the remaining computation amount of a task #m_task_t.
181 double MSG_task_get_remaining_computation(m_task_t task)
183 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
185 if(task->simdata->compute) {
186 return task->simdata->compute->remains;
188 return task->simdata->computation_amount;
192 /** \ingroup m_task_management
193 * \brief Returns the size of the data attached to a task #m_task_t.
196 double MSG_task_get_data_size(m_task_t task) {
197 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
199 return task->simdata->message_size;
202 MSG_error_t __MSG_task_wait_event(m_process_t process, m_task_t task)
205 m_process_t proc = NULL;
207 xbt_assert0(((task != NULL)
208 && (task->simdata != NULL)), "Invalid parameters");
210 xbt_dynar_push(task->simdata->sleeping, &process);
211 process->simdata->waiting_task = task;
213 process->simdata->waiting_task = NULL;
214 xbt_dynar_foreach(task->simdata->sleeping,_cursor,proc) {
216 xbt_dynar_remove_at(task->simdata->sleeping,_cursor,&proc);
223 /** \ingroup m_task_management
224 * \brief Changes the priority of a computation task. This priority doesn't affect
225 * the transfer rate. A priority of 2 will make a task receive two times more
226 * cpu power than the other ones.
229 void MSG_task_set_priority(m_task_t task, double priority) {
230 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
232 task->simdata->priority = 1/priority;
233 if(task->simdata->compute)
234 surf_workstation_resource->common_public->
235 set_priority(task->simdata->compute, task->simdata->priority);
238 /* Mallocator functions */
239 m_task_t task_mallocator_new_f(void) {
240 m_task_t task = xbt_new(s_m_task_t, 1);
241 simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
242 task->simdata = simdata;
246 void task_mallocator_free_f(m_task_t task) {
247 xbt_assert0((task != NULL), "Invalid parameter");
249 xbt_free(task->simdata);
255 void task_mallocator_reset_f(m_task_t task) {
256 memset(task->simdata, 0, sizeof(s_simdata_task_t));