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 != nullptr, "Failed to open file: %s", filename);
  61
  62   unsigned int i;
  63   SD_task_t root;
  64   SD_task_t end;
  65   SD_task_t task;
  66   xbt_dict_t computers;
  67   xbt_dynar_t computer = nullptr;
  68   xbt_dict_cursor_t dict_cursor;
  69   bool schedule_success = true;
  70
  71   xbt_dict_t jobs = xbt_dict_new_homogeneous(nullptr);
  72   xbt_dynar_t result = xbt_dynar_new(sizeof(SD_task_t), dot_task_p_free);
  73
  74   Agraph_t * dag_dot = agread(in_file, NIL(Agdisc_t *));
  75
  76   if (schedule)
  77     computers = xbt_dict_new_homogeneous(nullptr);
  78
  79   /* Create all the nodes */
  80   Agnode_t *node = nullptr;
  81   for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
  82     char *name = agnameof(node);
  83     double amount = atof(agget(node, (char*)"size"));
  84     task = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, name));
  85     if (task == nullptr) {
  86       if (seq_or_par == sequential){
  87         XBT_DEBUG("See <job id=%s amount =%.0f>", name, amount);
  88         task = SD_task_create_comp_seq(name, nullptr , amount);
  89       } else {
  90         double alpha = atof(agget(node, (char *) "alpha"));
  91         XBT_DEBUG("See <job id=%s amount =%.0f alpha = %.3f>", name, amount, alpha);
  92         task = SD_task_create_comp_par_amdahl(name, nullptr , amount, alpha);
  93       }
  94
  95       xbt_dict_set(jobs, name, task, nullptr);
  96
  97       if (strcmp(name,"root") && strcmp(name,"end"))
  98         xbt_dynar_push(result, &task);
  99
 100       if((seq_or_par == sequential) &&
 101         ((schedule && schedule_success) || XBT_LOG_ISENABLED(sd_dotparse, xbt_log_priority_verbose))){
 102         /* try to take the information to schedule the task only if all is right*/
 103         char *char_performer = agget(node, (char *) "performer");
 104         char *char_order = agget(node, (char *) "order");
 105         /* Tasks will execute on in a given "order" on a given set of "performer" hosts */
 106         int performer = ((!char_performer || !strcmp(char_performer,"")) ? -1:atoi(char_performer));
 107         int order = ((!char_order || !strcmp(char_order, ""))? -1:atoi(char_order));
 108
 109         if((performer != -1 && order != -1) && performer < (int) sg_host_count()){
 110           /* required parameters are given and less performers than hosts are required */
 111           XBT_DEBUG ("Task '%s' is scheduled on workstation '%d' in position '%d'", task->name, performer, order);
 112           if(!(computer = (xbt_dynar_t) xbt_dict_get_or_null(computers, char_performer))){
 113             computer = xbt_dynar_new(sizeof(SD_task_t), nullptr);
 114             xbt_dict_set(computers, char_performer, computer, nullptr);
 115           }
 116
 117           if((unsigned int)order < xbt_dynar_length(computer)){
 118             SD_task_t *task_test = (SD_task_t *)xbt_dynar_get_ptr(computer,order);
 119             if(*task_test && *task_test != task){
 120               /* the user gave the same order to several tasks */
 121               schedule_success = false;
 122               XBT_VERB("Task '%s' wants to start on performer '%s' at the same position '%s' as task '%s'",
 123                        (*task_test)->name, char_performer, char_order, task->name);
 124               continue;
 125             }
 126           }
 127           /* the parameter seems to be ok */
 128           xbt_dynar_set_as(computer, order, SD_task_t, task);
 129         } else {
 130           /* one of required parameters is not given */
 131           schedule_success = false;
 132           XBT_VERB("The schedule is ignored, task '%s' can not be scheduled on %d hosts", task->name, performer);
 133         }
 134       }
 135     } else {
 136       XBT_WARN("Task '%s' is defined more than once", name);
 137     }
 138   }
 139
 140   /*Check if 'root' and 'end' nodes have been explicitly declared.  If not, create them. */
 141   if (!(root = (SD_task_t)xbt_dict_get_or_null(jobs, "root")))
 142     root = (seq_or_par == sequential?SD_task_create_comp_seq("root", nullptr, 0):
 143                                      SD_task_create_comp_par_amdahl("root", nullptr, 0, 0));
 144
 145   SD_task_set_state(root, SD_SCHEDULABLE);   /* by design the root task is always SCHEDULABLE */
 146   xbt_dynar_insert_at(result, 0, &root);     /* Put it at the beginning of the dynar */
 147
 148   if (!(end = (SD_task_t)xbt_dict_get_or_null(jobs, "end")))
 149     end = (seq_or_par == sequential?SD_task_create_comp_seq("end", nullptr, 0):
 150                                     SD_task_create_comp_par_amdahl("end", nullptr, 0, 0));
 151
 152   /* Create edges */
 153   xbt_dynar_t edges = xbt_dynar_new(sizeof(Agedge_t*), nullptr);
 154   for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
 155     Agedge_t * edge;
 156     xbt_dynar_reset(edges);
 157     for (edge = agfstout(dag_dot, node); edge; edge = agnxtout(dag_dot, edge))
 158       xbt_dynar_push_as(edges, Agedge_t *, edge);
 159
 160     /* Be sure edges are sorted */
 161     xbt_dynar_sort(edges, edge_compare);
 162
 163     xbt_dynar_foreach(edges, i, edge) {
 164       char *src_name=agnameof(agtail(edge)), *dst_name=agnameof(aghead(edge));
 165       double size = atof(agget(edge, (char *) "size"));
 166
 167       SD_task_t src = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, src_name));
 168       SD_task_t dst = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, dst_name));
 169
 170       if (size > 0) {
 171         char *name = bprintf("%s->%s", src_name, dst_name);
 172         XBT_DEBUG("See <transfer id=%s amount = %.0f>", name, size);
 173         task = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, name));
 174         if (task == nullptr) {
 175           if (seq_or_par == sequential)
 176             task = SD_task_create_comm_e2e(name, nullptr , size);
 177           else
 178             task = SD_task_create_comm_par_mxn_1d_block(name, nullptr , size);
 179           SD_task_dependency_add(nullptr, nullptr, src, task);
 180           SD_task_dependency_add(nullptr, nullptr, task, dst);
 181           xbt_dict_set(jobs, name, task, nullptr);
 182           xbt_dynar_push(result, &task);
 183         } else {
 184           XBT_WARN("Task '%s' is defined more than once", name);
 185         }
 186         xbt_free(name);
 187       } else {
 188         SD_task_dependency_add(nullptr, nullptr, src, dst);
 189       }
 190     }
 191   }
 192   xbt_dynar_free(&edges);
 193
 194   XBT_DEBUG("All tasks have been created, put %s at the end of the dynar", end->name);
 195   xbt_dynar_push(result, &end);
 196
 197   /* Connect entry tasks to 'root', and exit tasks to 'end'*/
 198   xbt_dynar_foreach (result, i, task){
 199     if (task->predecessors->empty() && task->inputs->empty() && task != root) {
 200       XBT_DEBUG("Task '%s' has no source. Add dependency from 'root'", task->name);
 201       SD_task_dependency_add(nullptr, nullptr, root, task);
 202     }
 203
 204     if (task->successors->empty() && task->outputs->empty() && task != end) {
 205       XBT_DEBUG("Task '%s' has no destination. Add dependency to 'end'", task->name);
 206       SD_task_dependency_add(nullptr, nullptr, task, end);
 207     }
 208   }
 209
 210   agclose(dag_dot);
 211   xbt_dict_free(&jobs);
 212   fclose(in_file);
 213
 214   if(schedule){
 215     char *computer_name;
 216     if (schedule_success) {
 217       const sg_host_t *workstations = sg_host_list ();
 218       xbt_dict_foreach(computers,dict_cursor,computer_name,computer){
 219         SD_task_t previous_task = nullptr;
 220         xbt_dynar_foreach(computer, i, task){
 221           /* add dependency between the previous and the task to avoid parallel execution */
 222           if(task){
 223             if(previous_task && !SD_task_dependency_exists(previous_task, task))
 224               SD_task_dependency_add(nullptr, nullptr, previous_task, task);
 225
 226             SD_task_schedulel(task, 1, workstations[atoi(computer_name)]);
 227             previous_task = task;
 228           }
 229         }
 230         xbt_dynar_free(&computer);
 231       }
 232       xbt_dict_free(&computers);
 233     } else {
 234       XBT_WARN("The scheduling is ignored");
 235       xbt_dict_foreach(computers,dict_cursor,computer_name,computer)
 236         xbt_dynar_free(&computer);
 237       xbt_dict_free(&computers);
 238       xbt_dynar_free(&result);
 239       result = nullptr;
 240     }
 241   }
 242
 243   if (result && !acyclic_graph_detail(result)) {
 244     char* base = xbt_basename(filename);
 245     XBT_ERROR("The DOT described in %s is not a DAG. It contains a cycle.", base);
 246     free(base);
 247     xbt_dynar_free(&result);
 248     result = nullptr;
 249   }
 250   return result;
 251 }