src/simdag/sd_dotloader.cpp

   1 /* Copyright (c) 2009-2017. 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 "simdag_private.hpp"
   8 #include "simgrid/simdag.h"
   9 #include "src/internal_config.h"
  10 #include "xbt/file.h"
  11 #include <cstring>
  12 #include <unordered_map>
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_dotparse, sd, "Parsing DOT files");
  15
  16 #if HAVE_GRAPHVIZ
  17 #include <graphviz/cgraph.h>
  18
  19 xbt_dynar_t SD_dotload_generic(const char* filename, bool sequential, bool schedule);
  20
  21 static void dot_task_p_free(void *task) {
  22   SD_task_destroy(*(SD_task_t *)task);
  23 }
  24
  25 /** @brief loads a DOT file describing a DAG
  26  *
  27  * See http://www.graphviz.org/doc/info/lang.html  for more details.
  28  * The size attribute of a node describes:
  29  *   - for a compute task: the amount of flops to execute
  30  *   - for a communication task : the amount of bytes to transfer
  31  * If this attribute is ommited, the default value is zero.
  32  */
  33 xbt_dynar_t SD_dotload(const char *filename) {
  34   return SD_dotload_generic(filename, true, false);
  35 }
  36
  37 xbt_dynar_t SD_PTG_dotload(const char * filename) {
  38   return SD_dotload_generic(filename, false, false);
  39 }
  40
  41 xbt_dynar_t SD_dotload_with_sched(const char *filename) {
  42   return SD_dotload_generic(filename, true, true);
  43 }
  44
  45 static int edge_compare(const void *a, const void *b)
  46 {
  47   unsigned va = AGSEQ(*(Agedge_t **)a);
  48   unsigned vb = AGSEQ(*(Agedge_t **)b);
  49   if (va == vb)
  50     return 0;
  51   else
  52     return (va < vb ? -1 : 1);
  53 }
  54
  55 xbt_dynar_t SD_dotload_generic(const char* filename, bool sequential, bool schedule)
  56 {
  57   xbt_assert(filename, "Unable to use a null file descriptor\n");
  58   FILE *in_file = fopen(filename, "r");
  59   xbt_assert(in_file != nullptr, "Failed to open file: %s", filename);
  60
  61   unsigned int i;
  62   SD_task_t root;
  63   SD_task_t end;
  64   SD_task_t task;
  65   std::vector<SD_task_t>* computer;
  66   std::unordered_map<std::string, std::vector<SD_task_t>*> computers;
  67   bool schedule_success = true;
  68
  69   std::unordered_map<std::string, SD_task_t> jobs;
  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   /* Create all the nodes */
  75   Agnode_t *node = nullptr;
  76   for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
  77     char *name = agnameof(node);
  78     double amount = atof(agget(node, (char*)"size"));
  79     if (jobs.find(name) == jobs.end()) {
  80       if (sequential) {
  81         XBT_DEBUG("See <job id=%s amount =%.0f>", name, amount);
  82         task = SD_task_create_comp_seq(name, nullptr , amount);
  83       } else {
  84         double alpha = atof(agget(node, (char *) "alpha"));
  85         XBT_DEBUG("See <job id=%s amount =%.0f alpha = %.3f>", name, amount, alpha);
  86         task = SD_task_create_comp_par_amdahl(name, nullptr , amount, alpha);
  87       }
  88
  89       jobs.insert({std::string(name), task});
  90
  91       if (strcmp(name,"root") && strcmp(name,"end"))
  92         xbt_dynar_push(result, &task);
  93
  94       if ((sequential) &&
  95           ((schedule && schedule_success) || XBT_LOG_ISENABLED(sd_dotparse, xbt_log_priority_verbose))) {
  96         /* try to take the information to schedule the task only if all is right*/
  97         char *char_performer = agget(node, (char *) "performer");
  98         char *char_order = agget(node, (char *) "order");
  99         /* Tasks will execute on in a given "order" on a given set of "performer" hosts */
 100         int performer = ((not char_performer || not strcmp(char_performer, "")) ? -1 : atoi(char_performer));
 101         int order     = ((not char_order || not strcmp(char_order, "")) ? -1 : atoi(char_order));
 102
 103         if ((performer != -1 && order != -1) && performer < static_cast<int>(sg_host_count())) {
 104           /* required parameters are given and less performers than hosts are required */
 105           XBT_DEBUG ("Task '%s' is scheduled on workstation '%d' in position '%d'", task->name, performer, order);
 106           try {
 107             computer = computers.at(char_performer);
 108           } catch (std::out_of_range& unfound) {
 109             computer = new std::vector<SD_task_t>;
 110             computers.insert({char_performer, computer});
 111           }
 112           if (static_cast<unsigned int>(order) < computer->size()) {
 113             SD_task_t task_test = computer->at(order);
 114             if (task_test && task_test != task) {
 115               /* the user gave the same order to several tasks */
 116               schedule_success = false;
 117               XBT_VERB("Task '%s' wants to start on performer '%s' at the same position '%s' as task '%s'",
 118                        task_test->name, char_performer, char_order, task->name);
 119               continue;
 120             }
 121           } else
 122             computer->resize(order);
 123
 124           computer->insert(computer->begin() + order, task);
 125         } else {
 126           /* one of required parameters is not given */
 127           schedule_success = false;
 128           XBT_VERB("The schedule is ignored, task '%s' can not be scheduled on %d hosts", task->name, performer);
 129         }
 130       }
 131     } else {
 132       XBT_WARN("Task '%s' is defined more than once", name);
 133     }
 134   }
 135
 136   /*Check if 'root' and 'end' nodes have been explicitly declared.  If not, create them. */
 137   if (jobs.find("root") == jobs.end())
 138     root = (sequential ? SD_task_create_comp_seq("root", nullptr, 0)
 139                        : SD_task_create_comp_par_amdahl("root", nullptr, 0, 0));
 140   else
 141     root = jobs.at("root");
 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 (jobs.find("end") == jobs.end())
 147     end = (sequential ? SD_task_create_comp_seq("end", nullptr, 0)
 148                       : SD_task_create_comp_par_amdahl("end", nullptr, 0, 0));
 149   else
 150     end = jobs.at("end");
 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));
 165       char *dst_name=agnameof(aghead(edge));
 166       double size = atof(agget(edge, (char *) "size"));
 167
 168       SD_task_t src = jobs.at(src_name);
 169       SD_task_t dst = jobs.at(dst_name);
 170
 171       if (size > 0) {
 172         std::string name = std::string(src_name) + "->" + dst_name;
 173         XBT_DEBUG("See <transfer id=%s amount = %.0f>", name.c_str(), size);
 174         if (jobs.find(name) == jobs.end()) {
 175           if (sequential)
 176             task = SD_task_create_comm_e2e(name.c_str(), nullptr, size);
 177           else
 178             task = SD_task_create_comm_par_mxn_1d_block(name.c_str(), nullptr, size);
 179           SD_task_dependency_add(nullptr, nullptr, src, task);
 180           SD_task_dependency_add(nullptr, nullptr, task, dst);
 181           jobs.insert({name, task});
 182           xbt_dynar_push(result, &task);
 183         } else {
 184           XBT_WARN("Task '%s' is defined more than once", name.c_str());
 185         }
 186       } else {
 187         SD_task_dependency_add(nullptr, nullptr, src, dst);
 188       }
 189     }
 190   }
 191   xbt_dynar_free(&edges);
 192
 193   XBT_DEBUG("All tasks have been created, put %s at the end of the dynar", end->name);
 194   xbt_dynar_push(result, &end);
 195
 196   /* Connect entry tasks to 'root', and exit tasks to 'end'*/
 197   xbt_dynar_foreach (result, i, task){
 198     if (task->predecessors->empty() && task->inputs->empty() && task != root) {
 199       XBT_DEBUG("Task '%s' has no source. Add dependency from 'root'", task->name);
 200       SD_task_dependency_add(nullptr, nullptr, root, task);
 201     }
 202
 203     if (task->successors->empty() && task->outputs->empty() && task != end) {
 204       XBT_DEBUG("Task '%s' has no destination. Add dependency to 'end'", task->name);
 205       SD_task_dependency_add(nullptr, nullptr, task, end);
 206     }
 207   }
 208
 209   agclose(dag_dot);
 210   fclose(in_file);
 211
 212   if(schedule){
 213     if (schedule_success) {
 214       const sg_host_t *workstations = sg_host_list ();
 215       for (auto elm : computers) {
 216         SD_task_t previous_task = nullptr;
 217         for (auto task : *elm.second) {
 218           /* add dependency between the previous and the task to avoid parallel execution */
 219           if(task){
 220             if (previous_task && not SD_task_dependency_exists(previous_task, task))
 221               SD_task_dependency_add(nullptr, nullptr, previous_task, task);
 222
 223             SD_task_schedulel(task, 1, workstations[atoi(elm.first.c_str())]);
 224             previous_task = task;
 225           }
 226         }
 227         delete elm.second;
 228       }
 229     } else {
 230       XBT_WARN("The scheduling is ignored");
 231       for (auto elm : computers)
 232         delete elm.second;
 233       xbt_dynar_free(&result);
 234       result = nullptr;
 235     }
 236   }
 237
 238   if (result && not acyclic_graph_detail(result)) {
 239     char* base = xbt_basename(filename);
 240     XBT_ERROR("The DOT described in %s is not a DAG. It contains a cycle.", base);
 241     free(base);
 242     xbt_dynar_free(&result);
 243     result = nullptr;
 244   }
 245   return result;
 246 }
 247 #else
 248 xbt_dynar_t SD_dotload(const char *filename) {
 249   xbt_die("SD_dotload_generic() is not usable because graphviz was not found.\n"
 250       "Please install graphviz, graphviz-dev, and libgraphviz-dev (and erase CMakeCache.txt) before recompiling.");
 251 }
 252 xbt_dynar_t SD_dotload_with_sched(const char *filename) {
 253   return SD_dotload(filename);
 254 }
 255 xbt_dynar_t SD_PTG_dotload(const char * filename) {
 256   return SD_dotload(filename);
 257 }
 258 #endif