Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
put back some includes
[simgrid.git] / src / simdag / sd_dotloader.cpp
1 /* Copyright (c) 2009-2016. 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 "src/simdag/simdag_private.h"
8 #include "simgrid/simdag.h"
9 #include "xbt/file.h"
10 #include <string.h>
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_dotparse, sd, "Parsing DOT files");
13
14 #ifdef HAVE_CGRAPH_H
15 #include <graphviz/cgraph.h>
16 #elif HAVE_AGRAPH_H
17 #include <graphviz/agraph.h>
18 #define agnxtnode(dot, node)    agnxtnode(node)
19 #define agfstout(dot, node)     agfstout(node)
20 #define agnxtout(dot, edge)     agnxtout(edge)
21 #endif
22
23 typedef enum {
24   sequential =0,
25   parallel
26 } seq_par_t;
27
28 xbt_dynar_t SD_dotload_generic(const char * filename, seq_par_t seq_or_par, bool schedule);
29
30 static void dot_task_p_free(void *task) {
31   SD_task_destroy(*(SD_task_t *)task);
32 }
33
34 /** @brief loads a DOT file describing a DAG
35  * 
36  * See http://www.graphviz.org/doc/info/lang.html  for more details.
37  * The size attribute of a node describes:
38  *   - for a compute task: the amount of flops to execute
39  *   - for a communication task : the amount of bytes to transfer
40  * If this attribute is ommited, the default value is zero.
41  */
42 xbt_dynar_t SD_dotload(const char *filename) {
43   return SD_dotload_generic(filename, sequential, false);
44 }
45
46 xbt_dynar_t SD_PTG_dotload(const char * filename) {
47   return SD_dotload_generic(filename, parallel, false);
48 }
49
50 xbt_dynar_t SD_dotload_with_sched(const char *filename) {
51   return SD_dotload_generic(filename, sequential, true);
52 }
53
54 static int edge_compare(const void *a, const void *b)
55 {
56   unsigned va = AGSEQ(*(Agedge_t **)a);
57   unsigned vb = AGSEQ(*(Agedge_t **)b);
58   return va == vb ? 0 : (va < vb ? -1 : 1);
59 }
60
61 xbt_dynar_t SD_dotload_generic(const char * filename, seq_par_t seq_or_par, bool schedule){
62   xbt_assert(filename, "Unable to use a null file descriptor\n");
63   FILE *in_file = fopen(filename, "r");
64   xbt_assert(in_file != NULL, "Failed to open file: %s", filename);
65
66   unsigned int i;
67   SD_task_t root, end, task;
68   xbt_dict_t computers;
69   xbt_dynar_t computer = NULL;
70   xbt_dict_cursor_t dict_cursor;
71   bool schedule_success = true;
72
73   xbt_dict_t jobs = xbt_dict_new_homogeneous(NULL);
74   xbt_dynar_t result = xbt_dynar_new(sizeof(SD_task_t), dot_task_p_free);
75
76   Agraph_t * dag_dot = agread(in_file, NIL(Agdisc_t *));
77
78   if (schedule)
79     computers = xbt_dict_new_homogeneous(NULL);
80
81   /* Create all the nodes */
82   Agnode_t *node = NULL;
83   for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
84     char *name = agnameof(node);
85     double amount = atof(agget(node, (char *) "size"));
86
87     if (!(task = (SD_task_t)xbt_dict_get_or_null(jobs, name))) {
88       if (seq_or_par == sequential){
89         XBT_DEBUG("See <job id=%s amount =%.0f>", name, amount);
90         task = SD_task_create_comp_seq(name, NULL , amount);
91       } else {
92         double alpha = atof(agget(node, (char *) "alpha"));
93         XBT_DEBUG("See <job id=%s amount =%.0f alpha = %.3f>", name, amount, alpha);
94         task = SD_task_create_comp_par_amdahl(name, NULL , amount, alpha);
95       }
96
97       xbt_dict_set(jobs, name, task, NULL);
98
99       if (strcmp(name,"root") && strcmp(name,"end"))
100         xbt_dynar_push(result, &task);
101
102       if((seq_or_par == sequential) &&
103         ((schedule && schedule_success) || XBT_LOG_ISENABLED(sd_dotparse, xbt_log_priority_verbose))){
104         /* try to take the information to schedule the task only if all is right*/
105         char *char_performer = agget(node, (char *) "performer");
106         char *char_order = agget(node, (char *) "order");
107         /* Tasks will execute on in a given "order" on a given set of "performer" hosts */
108         int performer = ((!char_performer || !strcmp(char_performer,"")) ? -1:atoi(char_performer));
109         int order = ((!char_order || !strcmp(char_order, ""))? -1:atoi(char_order));
110
111         if((performer != -1 && order != -1) && performer < (int) sg_host_count()){
112           /* required parameters are given and less performers than hosts are required */
113           XBT_DEBUG ("Task '%s' is scheduled on workstation '%d' in position '%d'", task->name, performer, order);
114           if(!(computer = (xbt_dynar_t) xbt_dict_get_or_null(computers, char_performer))){
115             computer = xbt_dynar_new(sizeof(SD_task_t), NULL);
116             xbt_dict_set(computers, char_performer, computer, NULL);
117           }
118
119           if((unsigned int)order < xbt_dynar_length(computer)){
120             SD_task_t *task_test = (SD_task_t *)xbt_dynar_get_ptr(computer,order);
121             if(*task_test && *task_test != task){
122               /* the user gave the same order to several tasks */
123               schedule_success = false;
124               XBT_VERB("Task '%s' wants to start on performer '%s' at the same position '%s' as task '%s'",
125                        (*task_test)->name, char_performer, char_order, task->name);
126               continue;
127             }
128           }
129           /* the parameter seems to be ok */
130           xbt_dynar_set_as(computer, order, SD_task_t, task);
131         } else {
132           /* one of required parameters is not given */
133           schedule_success = false;
134           XBT_VERB("The schedule is ignored, task '%s' can not be scheduled on %d hosts", task->name, performer);
135         }
136       }
137     } else {
138       XBT_WARN("Task '%s' is defined more than once", name);
139     }
140   }
141
142   /*Check if 'root' and 'end' nodes have been explicitly declared.  If not, create them. */
143   if (!(root = (SD_task_t)xbt_dict_get_or_null(jobs, "root")))
144     root = (seq_or_par == sequential?SD_task_create_comp_seq("root", NULL, 0):
145                                      SD_task_create_comp_par_amdahl("root", NULL, 0, 0));
146
147   SD_task_set_state(root, SD_SCHEDULABLE);   /* by design the root task is always SCHEDULABLE */
148   xbt_dynar_insert_at(result, 0, &root);     /* Put it at the beginning of the dynar */
149
150   if (!(end = (SD_task_t)xbt_dict_get_or_null(jobs, "end")))
151     end = (seq_or_par == sequential?SD_task_create_comp_seq("end", NULL, 0):
152                                     SD_task_create_comp_par_amdahl("end", NULL, 0, 0));
153
154   /* Create edges */
155   xbt_dynar_t edges = xbt_dynar_new(sizeof(Agedge_t*), NULL);
156   for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
157     Agedge_t * edge;
158     xbt_dynar_reset(edges);
159     for (edge = agfstout(dag_dot, node); edge; edge = agnxtout(dag_dot, edge))
160       xbt_dynar_push_as(edges, Agedge_t *, edge);
161
162     /* Be sure edges are sorted */
163     xbt_dynar_sort(edges, edge_compare);
164
165     xbt_dynar_foreach(edges, i, edge) {
166       SD_task_t src, dst;
167       char *src_name=agnameof(agtail(edge)), *dst_name=agnameof(aghead(edge));
168       double size = atof(agget(edge, (char *) "size"));
169
170       src = (SD_task_t)xbt_dict_get_or_null(jobs, src_name);
171       dst = (SD_task_t)xbt_dict_get_or_null(jobs, dst_name);
172
173       if (size > 0) {
174         char *name = (char*)xbt_malloc((strlen(src_name)+strlen(dst_name)+6)*sizeof(char));
175         sprintf(name, "%s->%s", src_name, dst_name);
176         XBT_DEBUG("See <transfer id=%s amount = %.0f>", name, size);
177         if (!(task = (SD_task_t)xbt_dict_get_or_null(jobs, name))) {
178           if (seq_or_par == sequential)
179             task = SD_task_create_comm_e2e(name, NULL , size);
180           else
181             task = SD_task_create_comm_par_mxn_1d_block(name, NULL , size);
182           SD_task_dependency_add(NULL, NULL, src, task);
183           SD_task_dependency_add(NULL, NULL, task, dst);
184           xbt_dict_set(jobs, name, task, NULL);
185           xbt_dynar_push(result, &task);
186         } else {
187           XBT_WARN("Task '%s' is defined more than once", name);
188         }
189         xbt_free(name);
190       } else {
191         SD_task_dependency_add(NULL, NULL, src, dst);
192       }
193     }
194   }
195   xbt_dynar_free(&edges);
196
197   XBT_DEBUG("All tasks have been created, put %s at the end of the dynar", end->name);
198   xbt_dynar_push(result, &end);
199
200   /* Connect entry tasks to 'root', and exit tasks to 'end'*/
201   xbt_dynar_foreach (result, i, task){
202     if (xbt_dynar_is_empty(task->tasks_before) && task != root) {
203       XBT_DEBUG("Task '%s' has no source. Add dependency from 'root'", task->name);
204       SD_task_dependency_add(NULL, NULL, root, task);
205     }
206
207     if (xbt_dynar_is_empty(task->tasks_after) && task != end) {
208       XBT_DEBUG("Task '%s' has no destination. Add dependency to 'end'", task->name);
209       SD_task_dependency_add(NULL, NULL, task, end);
210     }
211   }
212
213   agclose(dag_dot);
214   xbt_dict_free(&jobs);
215   fclose(in_file);
216
217   if(schedule){
218     char *computer_name;
219     if (schedule_success) {
220       const sg_host_t *workstations = sg_host_list ();
221       xbt_dict_foreach(computers,dict_cursor,computer_name,computer){
222         SD_task_t previous_task = NULL;
223         xbt_dynar_foreach(computer, i, task){
224           /* add dependency between the previous and the task to avoid parallel execution */
225           if(task){
226             if(previous_task && !SD_task_dependency_exists(previous_task, task))
227               SD_task_dependency_add(NULL, NULL, previous_task, task);
228
229             SD_task_schedulel(task, 1, workstations[atoi(computer_name)]);
230             previous_task = task;
231           }
232         }
233         xbt_dynar_free(&computer);
234       }
235       xbt_dict_free(&computers);
236     } else {
237       XBT_WARN("The scheduling is ignored");
238       xbt_dict_foreach(computers,dict_cursor,computer_name,computer)
239         xbt_dynar_free(&computer);
240       xbt_dict_free(&computers);
241       xbt_dynar_free(&result);
242       result = NULL;
243     }
244   }
245
246   if (result && !acyclic_graph_detail(result)) {
247     XBT_ERROR("The DOT described in %s is not a DAG. It contains a cycle.", xbt_basename((char*)filename));
248     xbt_dynar_free(&result);
249     result = NULL;
250   }
251   return result;
252 }