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