src/simdag/sd_dotloader.c

   1 /* Copyright (c) 2009, 2010. 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
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_dotparse, sd, "Parsing DOT files");
  13
  14 #undef CLEANUP
  15
  16 #ifdef HAVE_AGRAPH_H
  17         #include <graphviz/agraph.h>
  18 #else
  19         #ifdef HAVE_GRAPH_H
  20                 #include <graphviz/graph.h>
  21         #else
  22                 #ifdef HAVE_CGRAPH_H
  23                         #include <graphviz/cgraph.h>
  24                 #endif
  25         #endif
  26 #endif
  27
  28 void dot_add_task(Agnode_t * dag_node);
  29 void dot_add_input_dependencies(SD_task_t current_job, Agedge_t * edge);
  30 void dot_add_output_dependencies(SD_task_t current_job, Agedge_t * edge);
  31 xbt_dynar_t SD_dotload_FILE(FILE * in_file);
  32
  33 static double dot_parse_double(const char *string)
  34 {
  35   if (string == NULL)
  36     return -1;
  37   int ret = 0;
  38   double value = -1;
  39
  40   ret = sscanf(string, "%lg", &value);
  41   if (ret != 1)
  42     WARN1("%s is not a double", string);
  43   return value;
  44 }
  45
  46 static int dot_parse_int(const char *string)
  47 {
  48   if (string == NULL)
  49     return -10;
  50   int ret = 0;
  51   int value;
  52
  53   ret = sscanf(string, "%d", &value);
  54   if (ret != 1)
  55     WARN1("%s is not an integer", string);
  56   return value;
  57 }
  58
  59 static xbt_dynar_t result;
  60 static xbt_dict_t jobs;
  61 static xbt_dict_t files;
  62 static SD_task_t root_task, end_task;
  63 static Agraph_t *dag_dot;
  64
  65 static void dump_res()
  66 {
  67   unsigned int cursor;
  68   SD_task_t task;
  69   xbt_dynar_foreach(result, cursor, task) {
  70     INFO1("Task %d", cursor);
  71     SD_task_dump(task);
  72   }
  73 }
  74
  75 static void dot_task_free(void *task)
  76 {
  77   SD_task_t t = task;
  78   SD_task_destroy(t);
  79 }
  80
  81 static void TRACE_sd_dotloader (SD_task_t task, const char *category)
  82 {
  83   if (category){
  84     if (strlen (category) != 0){
  85       TRACE_category (category);
  86       TRACE_sd_set_task_category (task, category);
  87     }
  88   }
  89 }
  90
  91 /** @brief loads a DOT file describing a DAG
  92  *
  93  * See http://www.graphviz.org/doc/info/lang.html
  94  * for more details.
  95  * To obtain information about transfers and tasks, two attributes are
  96  * required : size on task (execution time in Flop) and size on edge
  97  * (the amount of data transfer in bit).
  98  * if they aren't here, there choose to be equal to zero.
  99  */
 100 xbt_dynar_t SD_dotload(const char *filename)
 101 {
 102   FILE *in_file = fopen(filename, "r");
 103   xbt_assert1(in_file, "Unable to open \"%s\"\n", filename);
 104   SD_dotload_FILE(in_file);
 105   fclose(in_file);
 106   return result;
 107 }
 108
 109 xbt_dynar_t SD_dotload_FILE(FILE * in_file)
 110 {
 111   xbt_assert0(in_file, "Unable to use a null file descriptor\n");
 112   dag_dot = agread(in_file, NIL(Agdisc_t *));
 113
 114   result = xbt_dynar_new(sizeof(SD_task_t), dot_task_free);
 115   files = xbt_dict_new();
 116   jobs = xbt_dict_new();
 117   root_task = SD_task_create_comp_seq("root", NULL, 0);
 118   /* by design the root task is always SCHEDULABLE */
 119   __SD_task_set_state(root_task, SD_SCHEDULABLE);
 120
 121   xbt_dict_set(jobs, "root", root_task, NULL);
 122   xbt_dynar_push(result, &root_task);
 123   end_task = SD_task_create_comp_seq("end", NULL, 0);
 124   xbt_dict_set(jobs, "end", end_task, NULL);
 125
 126   Agnode_t *dag_node = NULL;
 127   for (dag_node = agfstnode(dag_dot); dag_node;
 128         #ifdef HAVE_CGRAPH_H
 129        dag_node = agnxtnode(dag_dot, dag_node)) {
 130     #endif
 131         #ifdef HAVE_AGRAPH_H
 132            dag_node = agnxtnode(dag_node)) {
 133         #endif
 134   dot_add_task(dag_node);
 135   }
 136   agclose(dag_dot);
 137   xbt_dict_free(&jobs);
 138
 139   /* And now, post-process the files.
 140    * We want a file task per pair of computation tasks exchanging the file. Duplicate on need
 141    * Files not produced in the system are said to be produced by root task (top of DAG).
 142    * Files not consumed in the system are said to be consumed by end task (bottom of DAG).
 143    */
 144   xbt_dict_cursor_t cursor;
 145   SD_task_t file;
 146   char *name;
 147   xbt_dict_foreach(files, cursor, name, file) {
 148     unsigned int cpt1, cpt2;
 149     SD_task_t newfile = NULL;
 150     SD_dependency_t depbefore, depafter;
 151     if (xbt_dynar_length(file->tasks_before) == 0) {
 152       xbt_dynar_foreach(file->tasks_after, cpt2, depafter) {
 153         SD_task_t newfile =
 154             SD_task_create_comm_e2e(file->name, NULL, file->amount);
 155         SD_task_dependency_add(NULL, NULL, root_task, newfile);
 156         SD_task_dependency_add(NULL, NULL, newfile, depafter->dst);
 157         xbt_dynar_push(result, &newfile);
 158       }
 159     } else if (xbt_dynar_length(file->tasks_after) == 0) {
 160       xbt_dynar_foreach(file->tasks_before, cpt2, depbefore) {
 161         SD_task_t newfile =
 162             SD_task_create_comm_e2e(file->name, NULL, file->amount);
 163         SD_task_dependency_add(NULL, NULL, depbefore->src, newfile);
 164         SD_task_dependency_add(NULL, NULL, newfile, end_task);
 165         xbt_dynar_push(result, &newfile);
 166       }
 167     } else {
 168       xbt_dynar_foreach(file->tasks_before, cpt1, depbefore) {
 169         xbt_dynar_foreach(file->tasks_after, cpt2, depafter) {
 170           if (depbefore->src == depafter->dst) {
 171             WARN2
 172                 ("File %s is produced and consumed by task %s. This loop dependency will prevent the execution of the task.",
 173                  file->name, depbefore->src->name);
 174           }
 175           newfile =
 176               SD_task_create_comm_e2e(file->name, NULL, file->amount);
 177           SD_task_dependency_add(NULL, NULL, depbefore->src, newfile);
 178           SD_task_dependency_add(NULL, NULL, newfile, depafter->dst);
 179           xbt_dynar_push(result, &newfile);
 180         }
 181       }
 182     }
 183   }
 184
 185   /* Push end task last */
 186   xbt_dynar_push(result, &end_task);
 187
 188   /* Free previous copy of the files */
 189   xbt_dict_free(&files);
 190
 191   return result;
 192 }
 193
 194 /* dot_add_task create a sd_task and all transfers required for this
 195  * task. The execution time of the task is given by the attribute size.
 196  * The unit of size is the Flop.*/
 197 void dot_add_task(Agnode_t * dag_node)
 198 {
 199   char *name = agnameof(dag_node);
 200   SD_task_t current_job;
 201   double runtime = dot_parse_double(agget(dag_node, (char *) "size"));
 202   long performer =
 203       (long) dot_parse_int((char *) agget(dag_node, (char *) "performer"));
 204   INFO3("See <job id=%s runtime=%s %.0f>", name,
 205         agget(dag_node, (char *) "size"), runtime);
 206   current_job = xbt_dict_get_or_null(jobs, name);
 207   if (current_job == NULL) {
 208     current_job =
 209         SD_task_create_comp_seq(name, (void *) performer, runtime);
 210 #ifdef HAVE_TRACING
 211    TRACE_sd_dotloader (current_job, agget (dag_node, (char*)"category"));
 212 #endif
 213     xbt_dict_set(jobs, name, current_job, NULL);
 214     xbt_dynar_push(result, &current_job);
 215   }
 216   Agedge_t *e;
 217   int count = 0;
 218
 219   #ifdef HAVE_CGRAPH_H
 220           for (e = agfstin(dag_dot, dag_node); e; e = agnxtin(dag_dot, e)) {
 221   #endif
 222   #ifdef HAVE_AGRAPH_H
 223           for (e = agfstin(dag_node); e; e = agnxtin(e)) {
 224   #endif
 225   dot_add_input_dependencies(current_job, e);
 226   count++;
 227   }
 228   if (count == 0 && current_job != root_task) {
 229     SD_task_dependency_add(NULL, NULL, root_task, current_job);
 230   }
 231   count = 0;
 232   #ifdef HAVE_CGRAPH_H
 233           for (e = agfstout(dag_dot, dag_node); e; e = agnxtout(dag_dot, e)) {
 234   #endif
 235   #ifdef HAVE_AGRAPH_H
 236           for (e = agfstout(dag_node); e; e = agnxtout(e)) {
 237   #endif
 238
 239     dot_add_output_dependencies(current_job, e);
 240     count++;
 241   }
 242   if (count == 0 && current_job != end_task) {
 243     SD_task_dependency_add(NULL, NULL, current_job, end_task);
 244   }
 245 }
 246
 247 /* dot_add_output_dependencies create the dependencies between a task
 248  * and a transfers. This is given by the edges in the dot file.
 249  * The amount of data transfers is given by the attribute size on the
 250  * edge. */
 251 void dot_add_input_dependencies(SD_task_t current_job, Agedge_t * edge)
 252 {
 253   SD_task_t file;
 254
 255   char name[80];
 256   sprintf(name, "%s->%s", agnameof(agtail(edge)), agnameof(aghead(edge)));
 257   double size = dot_parse_double(agget(edge, (char *) "size"));
 258   INFO2("size : %e, get size : %s", size, agget(edge, (char *) "size"));
 259   //int sender = dot_parse_int(agget(edge,(char*)"sender"));
 260   //int reciever = dot_parse_int(agget(edge,(char*)"reciever"));
 261   if (size > 0) {
 262     file = xbt_dict_get_or_null(files, name);
 263     if (file == NULL) {
 264       file = SD_task_create_comm_e2e(name, NULL, size);
 265 #ifdef HAVE_TRACING
 266       TRACE_sd_dotloader (file, agget (edge, (char*)"category"));
 267 #endif
 268       xbt_dict_set(files, name, file, &dot_task_free);
 269     } else {
 270       if (SD_task_get_amount(file) != size) {
 271         WARN3("Ignoring file %s size redefinition from %.0f to %.0f",
 272               name, SD_task_get_amount(file), size);
 273       }
 274     }
 275     SD_task_dependency_add(NULL, NULL, file, current_job);
 276   } else {
 277     file = xbt_dict_get_or_null(jobs, agnameof(agtail(edge)));
 278     if (file != NULL) {
 279       SD_task_dependency_add(NULL, NULL, file, current_job);
 280     }
 281   }
 282 }
 283
 284 /* dot_add_output_dependencies create the dependencies between a
 285  * transfers and a task. This is given by the edges in the dot file.
 286  * The amount of data transfers is given by the attribute size on the
 287  * edge. */
 288 void dot_add_output_dependencies(SD_task_t current_job, Agedge_t * edge)
 289 {
 290   SD_task_t file;
 291   char name[80];
 292   sprintf(name, "%s->%s", agnameof(agtail(edge)), agnameof(aghead(edge)));
 293   double size = dot_parse_double(agget(edge, (char *) "size"));
 294   INFO2("size : %e, get size : %s", size, agget(edge, (char *) "size"));
 295   //int sender = dot_parse_int(agget(edge,(char*)"sender"));
 296   //int reciever = dot_parse_int(agget(edge,(char*)"reciever"));
 297
 298   //INFO2("See <uses file=%s %s>",A_dot__uses_file,(is_input?"in":"out"));
 299   if (size > 0) {
 300     file = xbt_dict_get_or_null(files, name);
 301     if (file == NULL) {
 302       file = SD_task_create_comm_e2e(name, NULL, size);
 303 #ifdef HAVE_TRACING
 304       TRACE_sd_dotloader (file, agget (edge, (char*)"category"));
 305 #endif
 306       xbt_dict_set(files, name, file, &dot_task_free);
 307     } else {
 308       if (SD_task_get_amount(file) != size) {
 309         WARN3("Ignoring file %s size redefinition from %.0f to %.0f",
 310               name, SD_task_get_amount(file), size);
 311       }
 312     }
 313     SD_task_dependency_add(NULL, NULL, current_job, file);
 314     if (xbt_dynar_length(file->tasks_before) > 1) {
 315       WARN1("File %s created at more than one location...", file->name);
 316     }
 317   } else {
 318     file = xbt_dict_get_or_null(jobs, agnameof(aghead(edge)));
 319     if (file != NULL) {
 320       SD_task_dependency_add(NULL, NULL, current_job, file);
 321     }
 322   }
 323 }