Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
why let the user give a name to a dependency if s/he cannot get it
[simgrid.git] / src / simdag / sd_dotloader.c
1 /* Copyright (c) 2009-2013. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "private.h"
8 #include "simdag/simdag.h"
9 #include "xbt/misc.h"
10 #include "xbt/log.h"
11 #include <stdbool.h>
12 #include <string.h>
13 #include <libgen.h>
14
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_dotparse, sd, "Parsing DOT files");
16
17 #undef CLEANUP
18
19 #ifdef HAVE_CGRAPH_H
20 #include <graphviz/cgraph.h>
21 #elif HAVE_AGRAPH_H
22 #include <graphviz/agraph.h>
23 #define agnxtnode(dot, node)    agnxtnode(node)
24 #define agfstin(dot, node)      agfstin(node)
25 #define agnxtin(dot, edge)      agnxtin(edge)
26 #define agfstout(dot, node)     agfstout(node)
27 #define agnxtout(dot, edge)     agnxtout(edge)
28 #endif
29
30 typedef enum {
31   sequential =0,
32   parallel
33 } seq_par_t;
34
35 void dot_add_task(Agnode_t * dag_node);
36 void dot_add_parallel_task(Agnode_t * dag_node);
37 void dot_add_input_dependencies(SD_task_t current_job, Agedge_t * edge,
38                                 seq_par_t seq_or_par);
39 void dot_add_output_dependencies(SD_task_t current_job, Agedge_t * edge,
40                                  seq_par_t seq_or_par);
41 xbt_dynar_t SD_dotload_generic(const char * filename);
42
43 static double dot_parse_double(const char *string)
44 {
45   if (string == NULL)
46     return -1;
47   double value = -1;
48   char *err;
49
50   //ret = sscanf(string, "%lg", &value);
51   errno = 0;
52   value = strtod(string,&err);
53   if(errno)
54   {
55     XBT_WARN("Failed to convert string to double: %s\n",strerror(errno));
56     return -1;
57   }
58   return value;
59 }
60
61
62 static int dot_parse_int(const char *string)
63 {
64   if (string == NULL)
65     return -10;
66   int ret = 0;
67   int value = -1;
68
69   ret = sscanf(string, "%d", &value);
70   if (ret != 1)
71     XBT_WARN("%s is not an integer", string);
72   return value;
73 }
74
75 static xbt_dynar_t result;
76 static xbt_dict_t jobs;
77 static xbt_dict_t files;
78 static xbt_dict_t computers;
79 static SD_task_t root_task, end_task;
80 static Agraph_t *dag_dot;
81 static bool schedule = true;
82
83 static void dump_res()
84 {
85   unsigned int cursor;
86   SD_task_t task;
87   xbt_dynar_foreach(result, cursor, task) {
88     XBT_INFO("Task %d", cursor);
89     SD_task_dump(task);
90   }
91 }
92
93
94 static void dot_task_free(void *task)
95 {
96   SD_task_t t = task;
97   SD_task_destroy(t);
98 }
99
100 static void dot_task_p_free(void *task)
101 {
102   SD_task_t *t = task;
103   SD_task_destroy(*t);
104 }
105
106 static void TRACE_sd_dotloader (SD_task_t task, const char *category)
107 {
108   if (category){
109     if (strlen (category) != 0){
110       TRACE_category (category);
111       SD_task_set_category (task, category);
112     }
113   }
114 }
115
116 /** @brief loads a DOT file describing a DAG
117  * 
118  * See http://www.graphviz.org/doc/info/lang.html
119  * for more details.
120  * To obtain information about transfers and tasks, two attributes are
121  * required : size on task (execution time in Flop) and size on edge
122  * (the amount of data transfer in bit).
123  * if they aren't here, there choose to be equal to zero.
124  */
125 xbt_dynar_t SD_dotload(const char *filename)
126 {
127   SD_dotload_generic(filename);
128   xbt_dynar_t computer = NULL;
129   xbt_dict_cursor_t dict_cursor;
130   char *computer_name;
131   xbt_dict_foreach(computers,dict_cursor,computer_name,computer){
132     xbt_dynar_free(&computer);
133   }
134   xbt_dict_free(&computers);
135   return result;
136 }
137
138 xbt_dynar_t SD_dotload_with_sched(const char *filename){
139   SD_dotload_generic(filename);
140
141   if(schedule == true){
142     xbt_dynar_t computer = NULL;
143     xbt_dict_cursor_t dict_cursor;
144     char *computer_name;
145     const SD_workstation_t *workstations = SD_workstation_get_list ();
146     xbt_dict_foreach(computers,dict_cursor,computer_name,computer){
147       int count_computer = dot_parse_int(computer_name);
148       unsigned int count=0;
149       SD_task_t task;
150       SD_task_t task_previous = NULL;
151       xbt_dynar_foreach(computer,count,task){
152         // add dependency between the previous and the task to avoid
153         // parallel execution
154         if(task != NULL ){
155           if(task_previous != NULL &&
156              !SD_task_dependency_exists(task_previous, task))
157             SD_task_dependency_add(NULL, NULL, task_previous, task);
158           SD_task_schedulel(task, 1, workstations[count_computer]);
159           task_previous = task;
160         }
161       }
162       xbt_dynar_free(&computer);
163     }
164     xbt_dict_free(&computers);
165     if(acyclic_graph_detail(result))
166       return result;
167     else
168       XBT_WARN("There is at least one cycle in the provided task graph");
169   }else{
170     XBT_WARN("The scheduling is ignored");
171   }
172   SD_task_t task;
173   unsigned int count;
174   xbt_dynar_t computer = NULL;
175   xbt_dict_cursor_t dict_cursor;
176   char *computer_name;
177   xbt_dict_foreach(computers,dict_cursor,computer_name,computer){
178     xbt_dynar_free(&computer);
179   }
180   xbt_dict_free(&computers);
181   xbt_dynar_foreach(result,count,task){
182      SD_task_destroy(task);
183   }
184   return NULL;
185 }
186
187 xbt_dynar_t SD_PTG_dotload(const char * filename)
188 {
189   xbt_assert(filename, "Unable to use a null file descriptor\n");
190   FILE *in_file = fopen(filename, "r");
191   dag_dot = agread(in_file, NIL(Agdisc_t *));
192
193   result = xbt_dynar_new(sizeof(SD_task_t), dot_task_p_free);
194   files = xbt_dict_new_homogeneous(&dot_task_free);
195   jobs = xbt_dict_new_homogeneous(NULL);
196   computers = xbt_dict_new_homogeneous(NULL);
197   root_task = SD_task_create_comp_par_amdahl("root", NULL, 0., 0.);
198   /* by design the root task is always SCHEDULABLE */
199   __SD_task_set_state(root_task, SD_SCHEDULABLE);
200
201   xbt_dict_set(jobs, "root", root_task, NULL);
202   xbt_dynar_push(result, &root_task);
203   end_task = SD_task_create_comp_par_amdahl("end", NULL, 0., 0.);
204   xbt_dict_set(jobs, "end", end_task, NULL);
205
206   Agnode_t *dag_node = NULL;
207   for (dag_node = agfstnode(dag_dot); dag_node; dag_node = agnxtnode(dag_dot, dag_node)) {
208     dot_add_parallel_task(dag_node);
209   }
210   agclose(dag_dot);
211   xbt_dict_free(&jobs);
212
213   /* And now, post-process the files.
214    * We want a file task per pair of computation tasks exchanging the file. Duplicate on need
215    * Files not produced in the system are said to be produced by root task (top of DAG).
216    * Files not consumed in the system are said to be consumed by end task (bottom of DAG).
217    */
218   xbt_dict_cursor_t cursor;
219   SD_task_t file;
220   char *name;
221   xbt_dict_foreach(files, cursor, name, file) {
222     unsigned int cpt1, cpt2;
223     SD_task_t newfile = NULL;
224     SD_dependency_t depbefore, depafter;
225     if (xbt_dynar_is_empty(file->tasks_before)) {
226       xbt_dynar_foreach(file->tasks_after, cpt2, depafter) {
227         SD_task_t newfile =
228             SD_task_create_comm_par_mxn_1d_block(file->name, NULL, file->amount);
229         SD_task_dependency_add(NULL, NULL, root_task, newfile);
230         SD_task_dependency_add(NULL, NULL, newfile, depafter->dst);
231         xbt_dynar_push(result, &newfile);
232       }
233     } else if (xbt_dynar_is_empty(file->tasks_after)) {
234       xbt_dynar_foreach(file->tasks_before, cpt2, depbefore) {
235         SD_task_t newfile =
236             SD_task_create_comm_par_mxn_1d_block(file->name, NULL, file->amount);
237         SD_task_dependency_add(NULL, NULL, depbefore->src, newfile);
238         SD_task_dependency_add(NULL, NULL, newfile, end_task);
239         xbt_dynar_push(result, &newfile);
240       }
241     } else {
242       xbt_dynar_foreach(file->tasks_before, cpt1, depbefore) {
243         xbt_dynar_foreach(file->tasks_after, cpt2, depafter) {
244           if (depbefore->src == depafter->dst) {
245             XBT_WARN
246                 ("File %s is produced and consumed by task %s. This loop dependency will prevent the execution of the task.",
247                  file->name, depbefore->src->name);
248           }
249           newfile =
250               SD_task_create_comm_par_mxn_1d_block(file->name, NULL, file->amount);
251           SD_task_dependency_add(NULL, NULL, depbefore->src, newfile);
252           SD_task_dependency_add(NULL, NULL, newfile, depafter->dst);
253           xbt_dynar_push(result, &newfile);
254         }
255       }
256     }
257   }
258
259   /* Push end task last */
260   xbt_dynar_push(result, &end_task);
261
262   /* Free previous copy of the files */
263   xbt_dict_free(&files);
264   fclose(in_file);
265   if (!acyclic_graph_detail(result)) {
266     XBT_ERROR("The DOT described in %s is not a DAG. It contains a cycle.",
267               basename((char*)filename));
268     xbt_dynar_free(&result);
269     /* (result == NULL) here */
270   }
271   return result;
272 }
273
274
275 xbt_dynar_t SD_dotload_generic(const char * filename)
276 {
277   xbt_assert(filename, "Unable to use a null file descriptor\n");
278   //dag_dot =  agopen((char*)filename,Agstrictdirected,0);
279   FILE *in_file = fopen(filename, "r");
280   dag_dot = agread(in_file, NIL(Agdisc_t *));
281
282   result = xbt_dynar_new(sizeof(SD_task_t), dot_task_p_free);
283   files = xbt_dict_new_homogeneous(&dot_task_free);
284   jobs = xbt_dict_new_homogeneous(NULL);
285   computers = xbt_dict_new_homogeneous(NULL);
286   root_task = SD_task_create_comp_seq("root", NULL, 0);
287   /* by design the root task is always SCHEDULABLE */
288   __SD_task_set_state(root_task, SD_SCHEDULABLE);
289
290   xbt_dict_set(jobs, "root", root_task, NULL);
291   xbt_dynar_push(result, &root_task);
292   end_task = SD_task_create_comp_seq("end", NULL, 0);
293   xbt_dict_set(jobs, "end", end_task, NULL);
294
295   Agnode_t *dag_node = NULL;
296   for (dag_node = agfstnode(dag_dot); dag_node; dag_node = agnxtnode(dag_dot, dag_node)) {
297     dot_add_task(dag_node);
298   }
299   agclose(dag_dot);
300   xbt_dict_free(&jobs);
301
302   /* And now, post-process the files.
303    * We want a file task per pair of computation tasks exchanging the file. Duplicate on need
304    * Files not produced in the system are said to be produced by root task (top of DAG).
305    * Files not consumed in the system are said to be consumed by end task (bottom of DAG).
306    */
307   xbt_dict_cursor_t cursor;
308   SD_task_t file;
309   char *name;
310   xbt_dict_foreach(files, cursor, name, file) {
311     unsigned int cpt1, cpt2;
312     SD_task_t newfile = NULL;
313     SD_dependency_t depbefore, depafter;
314     if (xbt_dynar_is_empty(file->tasks_before)) {
315       xbt_dynar_foreach(file->tasks_after, cpt2, depafter) {
316         SD_task_t newfile =
317             SD_task_create_comm_e2e(file->name, NULL, file->amount);
318         SD_task_dependency_add(NULL, NULL, root_task, newfile);
319         SD_task_dependency_add(NULL, NULL, newfile, depafter->dst);
320         xbt_dynar_push(result, &newfile);
321       }
322     } else if (xbt_dynar_is_empty(file->tasks_after)) {
323       xbt_dynar_foreach(file->tasks_before, cpt2, depbefore) {
324         SD_task_t newfile =
325             SD_task_create_comm_e2e(file->name, NULL, file->amount);
326         SD_task_dependency_add(NULL, NULL, depbefore->src, newfile);
327         SD_task_dependency_add(NULL, NULL, newfile, end_task);
328         xbt_dynar_push(result, &newfile);
329       }
330     } else {
331       xbt_dynar_foreach(file->tasks_before, cpt1, depbefore) {
332         xbt_dynar_foreach(file->tasks_after, cpt2, depafter) {
333           if (depbefore->src == depafter->dst) {
334             XBT_WARN
335                 ("File %s is produced and consumed by task %s. This loop dependency will prevent the execution of the task.",
336                  file->name, depbefore->src->name);
337           }
338           newfile =
339               SD_task_create_comm_e2e(file->name, NULL, file->amount);
340           SD_task_dependency_add(NULL, NULL, depbefore->src, newfile);
341           SD_task_dependency_add(NULL, NULL, newfile, depafter->dst);
342           xbt_dynar_push(result, &newfile);
343         }
344       }
345     }
346   }
347
348   /* Push end task last */
349   xbt_dynar_push(result, &end_task);
350
351   /* Free previous copy of the files */
352   xbt_dict_free(&files);
353   fclose(in_file);
354   if (!acyclic_graph_detail(result)) {
355     XBT_ERROR("The DOT described in %s is not a DAG. It contains a cycle.",
356               basename((char*)filename));
357     xbt_dynar_free(&result);
358     /* (result == NULL) here */
359   }
360   return result;
361 }
362
363 /* dot_add_parallel_task create a sd_task of SD_TASK_COMP_PAR_AMDHAL type and
364  * all transfers required for this task. The execution time of the task is
365  * given by the attribute size. The unit of size is the Flop.*/
366 void dot_add_parallel_task(Agnode_t * dag_node)
367 {
368   char *name = agnameof(dag_node);
369   SD_task_t current_job;
370   double amount = dot_parse_double(agget(dag_node, (char *) "size"));
371   double alpha = dot_parse_double(agget(dag_node, (char *) "alpha"));
372
373   if (alpha == -1.)
374     alpha = 0.0;
375
376   XBT_DEBUG("See <job id=%s amount=%s %.0f alpha=%.2f>", name,
377         agget(dag_node, (char *) "size"), amount, alpha);
378   current_job = xbt_dict_get_or_null(jobs, name);
379   if (current_job == NULL) {
380     current_job =
381         SD_task_create_comp_par_amdahl(name, NULL , amount, alpha);
382 #ifdef HAVE_TRACING
383    TRACE_sd_dotloader (current_job, agget (dag_node, (char*)"category"));
384 #endif
385     xbt_dict_set(jobs, name, current_job, NULL);
386     xbt_dynar_push(result, &current_job);
387   }
388   Agedge_t *e;
389   int count = 0;
390
391   for (e = agfstin(dag_dot, dag_node); e; e = agnxtin(dag_dot, e)) {
392     dot_add_input_dependencies(current_job, e, parallel);
393     count++;
394   }
395   if (count == 0 && current_job != root_task) {
396     SD_task_dependency_add(NULL, NULL, root_task, current_job);
397   }
398   count = 0;
399   for (e = agfstout(dag_dot, dag_node); e; e = agnxtout(dag_dot, e)) {
400     dot_add_output_dependencies(current_job, e, parallel);
401     count++;
402   }
403   if (count == 0 && current_job != end_task) {
404     SD_task_dependency_add(NULL, NULL, current_job, end_task);
405   }
406 }
407
408 /* dot_add_task create a sd_task and all transfers required for this
409  * task. The execution time of the task is given by the attribute size.
410  * The unit of size is the Flop.*/
411 void dot_add_task(Agnode_t * dag_node)
412 {
413   char *name = agnameof(dag_node);
414   SD_task_t current_job;
415   double runtime = dot_parse_double(agget(dag_node, (char *) "size"));
416
417   XBT_DEBUG("See <job id=%s runtime=%s %.0f>", name,
418         agget(dag_node, (char *) "size"), runtime);
419   current_job = xbt_dict_get_or_null(jobs, name);
420   if (current_job == NULL) {
421     current_job =
422         SD_task_create_comp_seq(name, NULL , runtime);
423 #ifdef HAVE_TRACING
424    TRACE_sd_dotloader (current_job, agget (dag_node, (char*)"category"));
425 #endif
426     xbt_dict_set(jobs, name, current_job, NULL);
427     xbt_dynar_push(result, &current_job);
428   }
429   Agedge_t *e;
430   int count = 0;
431
432   for (e = agfstin(dag_dot, dag_node); e; e = agnxtin(dag_dot, e)) {
433     dot_add_input_dependencies(current_job, e, sequential);
434     count++;
435   }
436   if (count == 0 && current_job != root_task) {
437     SD_task_dependency_add(NULL, NULL, root_task, current_job);
438   }
439   count = 0;
440   for (e = agfstout(dag_dot, dag_node); e; e = agnxtout(dag_dot, e)) {
441     dot_add_output_dependencies(current_job, e, sequential);
442     count++;
443   }
444   if (count == 0 && current_job != end_task) {
445     SD_task_dependency_add(NULL, NULL, current_job, end_task);
446   }
447
448   if(schedule || XBT_LOG_ISENABLED(sd_dotparse, xbt_log_priority_verbose)){
449     /* try to take the information to schedule the task only if all is
450      * right*/
451     // performer is the computer which execute the task
452     unsigned long performer = -1;
453     char * char_performer = agget(dag_node, (char *) "performer");
454     if (char_performer != NULL)
455       performer = (long) dot_parse_int(char_performer);
456
457     // order is giving the task order on one computer
458     unsigned long order = -1;
459     char * char_order = agget(dag_node, (char *) "order");
460     if (char_order != NULL)
461       order = (long) dot_parse_int(char_order);
462     xbt_dynar_t computer = NULL;
463     //XBT_INFO("performer = %d, order=%d",performer,order);
464     if(performer != -1 && order != -1){
465       //necessary parameters are given
466       computer = xbt_dict_get_or_null(computers, char_performer);
467       if(computer == NULL){
468         computer = xbt_dynar_new(sizeof(SD_task_t), NULL);
469         xbt_dict_set(computers, char_performer, computer, NULL);
470       }
471       if(performer < xbt_lib_length(host_lib)){
472         // the  wanted computer is available
473         SD_task_t *task_test = NULL;
474         if(order < computer->used)
475           task_test = xbt_dynar_get_ptr(computer,order);
476         if(task_test != NULL && *task_test != NULL && *task_test != current_job){
477           /*the user gives the same order to several tasks*/
478           schedule = false;
479           XBT_VERB("The task %s starts on the computer %s at the position : %s like the task %s",
480                  (*task_test)->name, char_performer, char_order, current_job->name);
481         }else{
482           //the parameter seems to be ok
483           xbt_dynar_set_as(computer, order, SD_task_t, current_job);
484         }
485       }else{
486         /*the platform has not enough processors to schedule the DAG like
487         *the user wants*/
488         schedule = false;
489         XBT_VERB("The schedule is ignored, there are not enough computers");
490       }
491     }
492     else {
493       //one of necessary parameters are not given
494       schedule = false;
495       XBT_VERB("The schedule is ignored, the task %s is not correctly scheduled", current_job->name);
496     }
497   }
498 }
499
500 /* dot_add_output_dependencies create the dependencies between a task
501  * and a transfers. This is given by the edges in the dot file. 
502  * The amount of data transfers is given by the attribute size on the
503  * edge. */
504 void dot_add_input_dependencies(SD_task_t current_job, Agedge_t * edge,
505                                 seq_par_t seq_or_par)
506 {
507   SD_task_t file = NULL;
508   char *name_tail=agnameof(agtail(edge));
509   char *name_head=agnameof(aghead(edge));
510   char *name = xbt_malloc((strlen(name_head)+strlen(name_tail)+6)*sizeof(char));
511   sprintf(name, "%s->%s", name_tail, name_head);
512   double size = dot_parse_double(agget(edge, (char *) "size"));
513   XBT_DEBUG("size : %e, get size : %s", size, agget(edge, (char *) "size"));
514
515   if (size > 0) {
516     file = xbt_dict_get_or_null(files, name);
517     if (file == NULL) {
518       if (seq_or_par == sequential){
519           file = SD_task_create_comm_e2e(name, NULL, size);
520       } else {
521           file = SD_task_create_comm_par_mxn_1d_block(name, NULL, size);
522       }
523 #ifdef HAVE_TRACING
524       TRACE_sd_dotloader (file, agget (edge, (char*)"category"));
525 #endif
526       xbt_dict_set(files, name, file, NULL);
527     } else {
528       if (SD_task_get_amount(file) != size) {
529         XBT_WARN("Ignoring file %s size redefinition from %.0f to %.0f",
530               name, SD_task_get_amount(file), size);
531       }
532     }
533     SD_task_dependency_add(NULL, NULL, file, current_job);
534   } else {
535     file = xbt_dict_get_or_null(jobs, name_tail);
536     if (file != NULL) {
537       SD_task_dependency_add(NULL, NULL, file, current_job);
538     }
539   }
540   free(name);
541 }
542
543 /* dot_add_output_dependencies create the dependencies between a
544  * transfers and a task. This is given by the edges in the dot file.
545  * The amount of data transfers is given by the attribute size on the
546  * edge. */
547 void dot_add_output_dependencies(SD_task_t current_job, Agedge_t * edge,
548                                  seq_par_t seq_or_par){
549   SD_task_t file;
550   char *name_tail=agnameof(agtail(edge));
551   char *name_head=agnameof(aghead(edge));
552   char *name = xbt_malloc((strlen(name_head)+strlen(name_tail)+6)*sizeof(char));
553   sprintf(name, "%s->%s", name_tail, name_head);
554   double size = dot_parse_double(agget(edge, (char *) "size"));
555   XBT_DEBUG("size : %e, get size : %s", size, agget(edge, (char *) "size"));
556
557   if (size > 0) {
558     file = xbt_dict_get_or_null(files, name);
559     if (file == NULL) {
560       if (seq_or_par == sequential){
561           file = SD_task_create_comm_e2e(name, NULL, size);
562       } else {
563           file = SD_task_create_comm_par_mxn_1d_block(name, NULL, size);
564       }
565 #ifdef HAVE_TRACING
566       TRACE_sd_dotloader (file, agget (edge, (char*)"category"));
567 #endif
568       xbt_dict_set(files, name, file, NULL);
569     } else {
570       if (SD_task_get_amount(file) != size) {
571         XBT_WARN("Ignoring file %s size redefinition from %.0f to %.0f",
572               name, SD_task_get_amount(file), size);
573       }
574     }
575     SD_task_dependency_add(NULL, NULL, current_job, file);
576     if (xbt_dynar_length(file->tasks_before) > 1) {
577       XBT_WARN("File %s created at more than one location...", file->name);
578     }
579   } else {
580     file = xbt_dict_get_or_null(jobs, name_head);
581     if (file != NULL) {
582       SD_task_dependency_add(NULL, NULL, current_job, file);
583     }
584   }
585   free(name);
586 }