Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use swags to handle task states and change structure s_SD_task_t.
[simgrid.git] / src / simdag / sd_task.c
1 #include "private.h"
2 #include "simdag/simdag.h"
3 #include "xbt/sysdep.h"
4 #include "xbt/dynar.h"
5
6 static void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
7
8 /* Creates a task.
9  */
10 SD_task_t SD_task_create(const char *name, void *data, double amount) {
11   SD_CHECK_INIT_DONE();
12   xbt_assert0(amount > 0, "amount must be positive");
13
14   SD_task_t task = xbt_new0(s_SD_task_t, 1);
15
16   /* general information */
17   task->data = data; /* user data */
18   if (name != NULL)
19     task->name = xbt_strdup(name);
20   else
21     task->name = NULL;
22
23   task->state_set = sd_global->not_scheduled_task_set;
24   task->amount = amount;
25   task->surf_action = NULL;
26   task->watch_points = 0;
27
28   /* dependencies */
29   task->tasks_before = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
30   task->tasks_after = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
31
32   /* scheduling parameters */
33   task->workstation_nb = 0;
34   task->workstation_list = NULL;
35   task->computation_amount = NULL;
36   task->communication_amount = NULL;
37   task->rate = 0;
38
39   xbt_dynar_push(sd_global->tasks, &task);
40
41   return task;
42 }
43
44 /* Returns the data of a task.
45  */
46 void* SD_task_get_data(SD_task_t task) {
47   SD_CHECK_INIT_DONE();
48   xbt_assert0(task != NULL, "Invalid parameter");
49   return task->data;
50 }
51
52 /* Returns the state of a task: SD_NOT_SCHEDULED, SD_SCHEDULED, SD_RUNNING, SD_DONE or SD_FAILED.
53  */
54 e_SD_task_state_t SD_task_get_state(SD_task_t task) {
55   SD_CHECK_INIT_DONE();
56   xbt_assert0(task != NULL, "Invalid parameter");
57
58   if (task->state_set == sd_global->not_scheduled_task_set)
59     return SD_NOT_SCHEDULED;
60   if (task->state_set == sd_global->scheduled_task_set)
61     return SD_SCHEDULED;
62   if (task->state_set == sd_global->running_task_set)
63     return SD_RUNNING;
64   if (task->state_set == sd_global->done_task_set)
65     return SD_DONE;
66   return SD_FAILED;
67 }
68
69 /* Changes the state of a task and update the swags.
70  */
71 static void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state) {
72   xbt_swag_remove(task, task->state_set);
73   switch (new_state) {
74   case SD_NOT_SCHEDULED:
75     task->state_set = sd_global->not_scheduled_task_set;
76     break;
77   case SD_SCHEDULED:
78     task->state_set = sd_global->scheduled_task_set;
79     break;
80   case SD_RUNNING:
81     task->state_set = sd_global->running_task_set;
82     break;
83   case SD_DONE:
84     task->state_set = sd_global->done_task_set;
85     break;
86   default: /* SD_FAILED */
87     task->state_set = sd_global->failed_task_set;
88   }
89 }
90
91 /* Sets the data of a task.
92  */
93 void SD_task_set_data(SD_task_t task, void *data) {
94   SD_CHECK_INIT_DONE();
95   xbt_assert0(task != NULL, "Invalid parameter");
96   task->data = data;
97 }
98
99 /* Returns the name of a task. The name can be NULL.
100  */
101 const char* SD_task_get_name(SD_task_t task) {
102   SD_CHECK_INIT_DONE();
103   xbt_assert0(task != NULL, "Invalid parameter");
104   return task->name;
105 }
106
107 /* Returns the computing amount of a task.
108  */
109 double SD_task_get_amount(SD_task_t task) {
110   SD_CHECK_INIT_DONE();
111   xbt_assert0(task != NULL, "Invalid parameter");
112   return task->amount;
113 }
114
115 /* Returns the remaining computing amount of a task.
116  */
117 double SD_task_get_remaining_amount(SD_task_t task) {
118   SD_CHECK_INIT_DONE();
119   xbt_assert0(task != NULL, "Invalid parameter");
120   
121   if (task->surf_action)
122     return task->amount;
123   else
124     return task->surf_action->remains;
125 }
126
127 /* temporary function for debbuging
128 void __SD_print_dependencies(SD_task_t task) {
129   printf("The following tasks must be executed before %s:", SD_task_get_name(task));
130   xbt_dynar_t dynar = task->tasks_before;
131   int length = xbt_dynar_length(dynar);
132   int i;
133   SD_dependency_t dependency;
134   for (i = 0; i < length; i++) {
135     xbt_dynar_get_cpy(dynar, i, &dependency);
136     printf(" %s", SD_task_get_name(dependency->src));
137   }
138
139   printf("\nThe following tasks must be executed after %s:", SD_task_get_name(task));
140
141   dynar = task->tasks_after;
142   length = xbt_dynar_length(dynar);
143   for (i = 0; i < length; i++) {
144     xbt_dynar_get_cpy(dynar, i, &dependency);
145     printf(" %s", SD_task_get_name(dependency->dst));
146   }
147   printf("\n----------------------------\n");
148 }*/
149
150 /* Destroys a dependency between two tasks.
151  */
152 void __SD_task_destroy_dependency(void *dependency) {
153   if (((SD_dependency_t) dependency)->name != NULL)
154     xbt_free(((SD_dependency_t) dependency)->name);
155   xbt_free(dependency);
156 }
157
158 /* Adds a dependency between two tasks.
159  */
160 void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst) {
161   SD_CHECK_INIT_DONE();
162   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
163   xbt_assert1(src != dst, "Cannot add a dependency between task '%s' and itself", SD_task_get_name(src));
164
165   xbt_dynar_t dynar = src->tasks_after;
166   int length = xbt_dynar_length(dynar);
167   int found = 0;
168   int i;
169   SD_dependency_t dependency;
170   for (i = 0; i < length && !found; i++) {
171     xbt_dynar_get_cpy(dynar, i, &dependency);
172     found = (dependency->dst == dst);
173   }
174   xbt_assert2(!found, "A dependency already exists between task '%s' and task '%s'", SD_task_get_name(src), SD_task_get_name(dst));
175
176   dependency = xbt_new0(s_SD_dependency_t, 1);
177
178   if (name != NULL)
179     dependency->name = xbt_strdup(name);
180   dependency->data = data;
181   dependency->src = src;
182   dependency->dst = dst;
183
184   /* src must be executed before dst */
185   xbt_dynar_push(src->tasks_after, &dependency);
186   xbt_dynar_push(dst->tasks_before, &dependency);
187
188   /*  __SD_print_dependencies(src);
189       __SD_print_dependencies(dst); */
190 }
191
192 /* Removes a dependency between two tasks.
193  */
194 void SD_task_dependency_remove(SD_task_t src, SD_task_t dst) {
195   SD_CHECK_INIT_DONE();
196   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
197   xbt_assert1(src != dst, "Cannot remove a dependency between task '%s' and itself", SD_task_get_name(src));
198
199   xbt_dynar_t dynar = src->tasks_after;
200   int length = xbt_dynar_length(dynar);
201   int found = 0;
202   int i;
203   SD_dependency_t dependency;
204   for (i = 0; i < length && !found; i++) {
205     xbt_dynar_get_cpy(dynar, i, &dependency);
206     if (dependency->dst == dst) {
207       xbt_dynar_remove_at(dynar, i, NULL);
208       found = 1;
209     }
210   }
211   xbt_assert4(found, "No dependency found between task '%s' and '%s': task '%s' is not a successor of task '%s'",
212               SD_task_get_name(src), SD_task_get_name(dst), SD_task_get_name(dst), SD_task_get_name(src));
213
214   dynar = dst->tasks_before;
215   length = xbt_dynar_length(dynar);
216   found = 0;
217   
218   for (i = 0; i < length && !found; i++) {
219     xbt_dynar_get_cpy(dynar, i, &dependency);
220     if (dependency->src == src) {
221       xbt_dynar_remove_at(dynar, i, NULL);
222       __SD_task_destroy_dependency(dependency);
223       found = 1;
224     }
225   }
226   xbt_assert4(found, "SimDag error: task '%s' is a successor of '%s' but task '%s' is not a predecessor of task '%s'",
227               SD_task_get_name(dst), SD_task_get_name(src), SD_task_get_name(src), SD_task_get_name(dst)); /* should never happen... */
228
229   /*   __SD_print_dependencies(src); 
230        __SD_print_dependencies(dst); */
231 }
232
233 /* Returns the data associated to a dependency between two tasks. This data can be NULL.
234  */
235 void *SD_task_dependency_get_data(SD_task_t src, SD_task_t dst) {
236   SD_CHECK_INIT_DONE();
237   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
238   xbt_assert1(src != dst, "Cannot have a dependency between task '%s' and itself", SD_task_get_name(src));
239
240   xbt_dynar_t dynar = src->tasks_after;
241   int length = xbt_dynar_length(dynar);
242   int found = 0;
243   int i;
244   SD_dependency_t dependency;
245   for (i = 0; i < length && !found; i++) {
246     xbt_dynar_get_cpy(dynar, i, &dependency);
247     found = (dependency->dst == dst);
248   }
249   xbt_assert2(found, "No dependency found between task '%s' and '%s'", SD_task_get_name(src), SD_task_get_name(dst));
250   return dependency->data;
251 }
252
253 /* temporary function for debugging */
254 static void __SD_print_watch_points(SD_task_t task) {
255   static const int state_masks[] = {SD_SCHEDULED, SD_RUNNING, SD_DONE, SD_FAILED};
256   static const char* state_names[] = {"scheduled", "running", "done", "failed"};
257
258   printf("Task '%s' watch points (%x): ", SD_task_get_name(task), task->watch_points);
259
260   int i;
261   for (i = 0; i < 4; i++) {
262     if (task->watch_points & state_masks[i])
263       printf("%s ", state_names[i]);
264   }
265   printf("\n");
266 }
267
268 /* Adds a watch point to a task.
269    SD_simulate will stop as soon as the state of this task is the one given in argument.
270    Watch point is then automatically removed.
271  */
272 void SD_task_watch(SD_task_t task, e_SD_task_state_t state) {
273   SD_CHECK_INIT_DONE();
274   xbt_assert0(task != NULL, "Invalid parameter");
275
276   task->watch_points = task->watch_points | state;
277   __SD_print_watch_points(task);
278 }
279
280 /* Removes a watch point from a task.
281  */
282 void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state) {
283   SD_CHECK_INIT_DONE();
284   xbt_assert0(task != NULL, "Invalid parameter");
285   
286   task->watch_points = task->watch_points & ~state;
287   __SD_print_watch_points(task);
288 }
289
290 /* Destroys the data memorised by SD_task_schedule. Task state must be SD_SCHEDULED.
291  */
292 static void __SD_task_destroy_scheduling_data(SD_task_t task) {
293   xbt_free(task->workstation_list);
294   xbt_free(task->computation_amount);
295   xbt_free(task->communication_amount);
296 }
297
298 /* Schedules a task.
299  * task: the task to schedule
300  * workstation_nb: number of workstations where the task will be executed
301  * workstation_list: workstations where the task will be executed
302  * computation_amount: computation amount for each workstation
303  * communication_amount: communication amount between each pair of workstations
304  * rate: task execution speed rate
305  */
306 void SD_task_schedule(SD_task_t task, int workstation_nb,
307                      const SD_workstation_t *workstation_list, double *computation_amount,
308                      double *communication_amount, double rate) {
309   SD_CHECK_INIT_DONE();
310   xbt_assert0(task, "Invalid parameter");
311   xbt_assert1(SD_task_get_state(task) == SD_NOT_SCHEDULED, "Task '%s' has already been scheduled.", SD_task_get_name(task));
312   xbt_assert0(workstation_nb > 0, "workstation_nb must be positive");
313
314   task->workstation_nb = workstation_nb;
315   task->rate = rate;
316
317   task->computation_amount = xbt_new0(double, workstation_nb);
318   memcpy(task->computation_amount, computation_amount, sizeof(double) * workstation_nb);
319
320   int communication_nb = workstation_nb * workstation_nb;
321   task->communication_amount = xbt_new0(double, communication_nb);
322   memcpy(task->communication_amount, communication_amount, sizeof(double) * communication_nb);
323
324   /* we have to create a Surf workstation array instead of the SimDag workstation array */
325   task->workstation_list = xbt_new0(void*, workstation_nb);
326   int i;
327   for (i = 0; i < workstation_nb; i++) {
328     task->workstation_list[i] = workstation_list[i]->sd_data->surf_workstation;
329   }
330
331   __SD_task_set_state(task, SD_SCHEDULED);
332 }
333
334 /* Unschedules a task. The state must be SD_SCHEDULED, SD_RUNNING or SD_FAILED.
335  * The task is reinitialised and its state becomes SD_NOT_SCHEDULED.
336  * Call SD_task_schedule to schedule it again.
337  */
338 void SD_task_unschedule(SD_task_t task) {
339   SD_CHECK_INIT_DONE();
340   xbt_assert0(task != NULL, "Invalid parameter");
341   e_SD_task_state_t state = SD_task_get_state(task);
342   xbt_assert1(state == SD_SCHEDULED ||
343               state == SD_RUNNING ||
344               state == SD_FAILED,
345               "Task %s: the state must be SD_SCHEDULED, SD_RUNNING or SD_FAILED", SD_task_get_name(task));
346
347   if (state == SD_SCHEDULED)
348     __SD_task_destroy_scheduling_data(task);
349
350   __SD_task_set_state(task, SD_NOT_SCHEDULED);
351 }
352
353 /* Runs a task. This function is called by SD_simulate when a scheduled task can start
354  * (ie when its dependencies are satisfied).
355  */
356 surf_action_t __SD_task_run(SD_task_t task) {
357   SD_CHECK_INIT_DONE();
358   xbt_assert0(task != NULL, "Invalid parameter");
359
360
361   surf_action_t surf_action = surf_workstation_resource->extension_public->
362     execute_parallel_task(task->workstation_nb,
363                           task->workstation_list,
364                           task->computation_amount,
365                           task->communication_amount,
366                           task->amount,
367                           task->rate);
368   __SD_task_set_state(task, SD_RUNNING);
369
370   __SD_task_destroy_scheduling_data(task); /* now the scheduling data are not useful anymore */
371   return surf_action;
372 }
373
374
375 /* Destroys a task. The user data (if any) should have been destroyed first.
376  */
377 void SD_task_destroy(SD_task_t task) {
378   SD_CHECK_INIT_DONE();
379   xbt_assert0(task != NULL, "Invalid parameter");
380
381   /*printf("Destroying task %s...\n", SD_task_get_name(task));*/
382
383   /* remove the task from SimDag task list */
384   int index = xbt_dynar_search(sd_global->tasks, &task);
385   xbt_dynar_remove_at(sd_global->tasks, index, NULL);
386
387   /* we must destroy the dependencies carefuly (with SD_dependency_remove)
388      because each one is stored twice */
389   SD_dependency_t dependency;
390   while (xbt_dynar_length(task->tasks_before) > 0) {
391     xbt_dynar_get_cpy(task->tasks_before, 0, &dependency);
392     SD_task_dependency_remove(dependency->src, dependency->dst);
393   }
394
395   while (xbt_dynar_length(task->tasks_after) > 0) {
396     xbt_dynar_get_cpy(task->tasks_after, 0, &dependency);
397     SD_task_dependency_remove(dependency->src, dependency->dst);
398   }
399
400   /* if the task was scheduled we have to free the scheduling parameters */
401   if (SD_task_get_state(task) == SD_SCHEDULED)
402     __SD_task_destroy_scheduling_data(task);
403
404   if (task->name != NULL)
405     xbt_free(task->name);
406
407   xbt_dynar_free(&task->tasks_before);
408   xbt_dynar_free(&task->tasks_after);
409   xbt_free(task);
410
411   /*printf("Task destroyed.\n");*/
412
413 }