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.
16 * Since most scheduling algorithms rely on a concept of task
17 * that can be either <em>computed</em> locally or
18 * <em>transferred</em> on another processor, it seems to be the
19 * right level of abstraction for our purposes. A <em>task</em>
20 * may then be defined by a <em>computing amount</em>, a
21 * <em>message size</em> and some <em>private data</em>.
24 /********************************* Task **************************************/
25 /** \ingroup m_task_management
26 * \brief Creates a new #m_task_t.
28 * A constructor for #m_task_t taking four arguments and returning the
30 * \param name a name for the object. It is for user-level information
32 * \param compute_duration a value of the processing amount (in Mflop)
33 needed to process this new task. If 0, then it cannot be executed with
34 MSG_task_execute(). This value has to be >=0.
35 * \param message_size a value of the amount of data (in Mb) needed to
36 transfer this new task. If 0, then it cannot be transfered with
37 MSG_task_get() and MSG_task_put(). This value has to be >=0.
38 * \param data a pointer to any data may want to attach to the new
39 object. It is for user-level information and can be NULL. It can
40 be retrieved with the function \ref MSG_task_get_data.
42 * \return The new corresponding object.
44 m_task_t MSG_task_create(const char *name, double compute_duration,
45 double message_size, void *data)
47 simdata_task_t simdata = xbt_new0(s_simdata_task_t,1);
48 m_task_t task = xbt_new0(s_m_task_t,1);
51 task->name = xbt_strdup(name);
52 task->simdata = simdata;
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;
124 xbt_assert0((task != NULL), "Invalid parameter");
126 task->simdata->using--;
127 if(task->simdata->using>0) return MSG_OK;
129 xbt_assert0((xbt_dynar_length(task->simdata->sleeping)==0),
130 "Task still used. There is a problem. Cannot destroy it now!");
132 if(task->name) free(task->name);
134 xbt_dynar_free(&(task->simdata->sleeping));
136 action = task->simdata->compute;
137 if(action) action->resource_type->common_public->action_free(action);
138 action = task->simdata->comm;
139 if(action) action->resource_type->common_public->action_free(action);
140 if(task->simdata->host_list) xbt_free(task->simdata->host_list);
149 /** \ingroup m_task_management
150 * \brief Cancel a #m_task_t.
151 * \param task the taskt to cancel. If it was executed or transfered, it
152 stops the process that were working on it.
154 MSG_error_t MSG_task_cancel(m_task_t task)
156 xbt_assert0((task != NULL), "Invalid parameter");
158 if(task->simdata->compute) {
159 surf_workstation_resource->common_public->action_cancel(task->simdata->compute);
162 if(task->simdata->comm) {
163 surf_workstation_resource->common_public->action_cancel(task->simdata->comm);
170 /** \ingroup m_task_management
171 * \brief Returns the computation amount needed to process a task #m_task_t.
172 * Once a task has been processed, this amount is thus set to 0...
174 double MSG_task_get_compute_duration(m_task_t task) {
175 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
177 return task->simdata->computation_amount;
180 /** \ingroup m_task_management
181 * \brief Returns the remaining computation amount of a task #m_task_t.
184 double MSG_task_get_remaining_computation(m_task_t task)
186 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
188 if(task->simdata->compute) {
189 return task->simdata->compute->remains;
191 return task->simdata->computation_amount;
195 /** \ingroup m_task_management
196 * \brief Returns the size of the data attached to a task #m_task_t.
199 double MSG_task_get_data_size(m_task_t task) {
200 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
202 return task->simdata->message_size;
205 MSG_error_t __MSG_task_wait_event(m_process_t process, m_task_t task)
208 m_process_t proc = NULL;
210 xbt_assert0(((task != NULL)
211 && (task->simdata != NULL)), "Invalid parameters");
213 xbt_dynar_push(task->simdata->sleeping, &process);
214 process->simdata->waiting_task = task;
216 process->simdata->waiting_task = NULL;
217 xbt_dynar_foreach(task->simdata->sleeping,_cursor,proc) {
219 xbt_dynar_remove_at(task->simdata->sleeping,_cursor,&proc);
226 /** \ingroup m_task_management
227 * \brief Changes the priority of a computation task. This priority doesn't affect
228 * the transfer rate. A priority of 2 will make a task receive two times more
229 * cpu power than the other ones.
232 void MSG_task_set_priority(m_task_t task, double priority) {
233 xbt_assert0((task != NULL) && (task->simdata != NULL), "Invalid parameter");
235 task->simdata->priority = 1/priority;
236 if(task->simdata->compute)
237 surf_workstation_resource->common_public->
238 set_priority(task->simdata->compute, task->simdata->priority);