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