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