1 /* Copyright (c) 2009-2016. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "src/internal_config.h"
8 #include "simgrid/simdag.h"
11 #include "simdag_private.hpp"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_dotparse, sd, "Parsing DOT files");
16 #include <graphviz/cgraph.h>
23 xbt_dynar_t SD_dotload_generic(const char * filename, seq_par_t seq_or_par, bool schedule);
25 static void dot_task_p_free(void *task) {
26 SD_task_destroy(*(SD_task_t *)task);
29 /** @brief loads a DOT file describing a DAG
31 * See http://www.graphviz.org/doc/info/lang.html for more details.
32 * The size attribute of a node describes:
33 * - for a compute task: the amount of flops to execute
34 * - for a communication task : the amount of bytes to transfer
35 * If this attribute is ommited, the default value is zero.
37 xbt_dynar_t SD_dotload(const char *filename) {
38 return SD_dotload_generic(filename, sequential, false);
41 xbt_dynar_t SD_PTG_dotload(const char * filename) {
42 return SD_dotload_generic(filename, parallel, false);
45 xbt_dynar_t SD_dotload_with_sched(const char *filename) {
46 return SD_dotload_generic(filename, sequential, true);
49 static int edge_compare(const void *a, const void *b)
51 unsigned va = AGSEQ(*(Agedge_t **)a);
52 unsigned vb = AGSEQ(*(Agedge_t **)b);
53 return va == vb ? 0 : (va < vb ? -1 : 1);
56 xbt_dynar_t SD_dotload_generic(const char * filename, seq_par_t seq_or_par, bool schedule){
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);
66 xbt_dynar_t computer = nullptr;
67 xbt_dict_cursor_t dict_cursor;
68 bool schedule_success = true;
70 xbt_dict_t jobs = xbt_dict_new_homogeneous(nullptr);
71 xbt_dynar_t result = xbt_dynar_new(sizeof(SD_task_t), dot_task_p_free);
73 Agraph_t * dag_dot = agread(in_file, NIL(Agdisc_t *));
76 computers = xbt_dict_new_homogeneous(nullptr);
78 /* Create all the nodes */
79 Agnode_t *node = nullptr;
80 for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
81 char *name = agnameof(node);
82 double amount = atof(agget(node, (char*)"size"));
83 task = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, name));
84 if (task == nullptr) {
85 if (seq_or_par == sequential){
86 XBT_DEBUG("See <job id=%s amount =%.0f>", name, amount);
87 task = SD_task_create_comp_seq(name, nullptr , amount);
89 double alpha = atof(agget(node, (char *) "alpha"));
90 XBT_DEBUG("See <job id=%s amount =%.0f alpha = %.3f>", name, amount, alpha);
91 task = SD_task_create_comp_par_amdahl(name, nullptr , amount, alpha);
94 xbt_dict_set(jobs, name, task, nullptr);
96 if (strcmp(name,"root") && strcmp(name,"end"))
97 xbt_dynar_push(result, &task);
99 if((seq_or_par == sequential) &&
100 ((schedule && schedule_success) || XBT_LOG_ISENABLED(sd_dotparse, xbt_log_priority_verbose))){
101 /* try to take the information to schedule the task only if all is right*/
102 char *char_performer = agget(node, (char *) "performer");
103 char *char_order = agget(node, (char *) "order");
104 /* Tasks will execute on in a given "order" on a given set of "performer" hosts */
105 int performer = ((!char_performer || !strcmp(char_performer,"")) ? -1:atoi(char_performer));
106 int order = ((!char_order || !strcmp(char_order, ""))? -1:atoi(char_order));
108 if((performer != -1 && order != -1) && performer < (int) sg_host_count()){
109 /* required parameters are given and less performers than hosts are required */
110 XBT_DEBUG ("Task '%s' is scheduled on workstation '%d' in position '%d'", task->name, performer, order);
111 computer = static_cast<xbt_dynar_t> (xbt_dict_get_or_null(computers, char_performer));
112 if(computer == nullptr){
113 computer = xbt_dynar_new(sizeof(SD_task_t), nullptr);
114 xbt_dict_set(computers, char_performer, computer, nullptr);
117 if(static_cast<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);
127 /* the parameter seems to be ok */
128 xbt_dynar_set_as(computer, order, SD_task_t, task);
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);
136 XBT_WARN("Task '%s' is defined more than once", name);
140 /*Check if 'root' and 'end' nodes have been explicitly declared. If not, create them. */
141 root = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, "root"));
143 root = (seq_or_par == sequential?SD_task_create_comp_seq("root", nullptr, 0):
144 SD_task_create_comp_par_amdahl("root", nullptr, 0, 0));
146 SD_task_set_state(root, SD_SCHEDULABLE); /* by design the root task is always SCHEDULABLE */
147 xbt_dynar_insert_at(result, 0, &root); /* Put it at the beginning of the dynar */
149 end = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, "end"));
151 end = (seq_or_par == sequential?SD_task_create_comp_seq("end", nullptr, 0):
152 SD_task_create_comp_par_amdahl("end", nullptr, 0, 0));
155 xbt_dynar_t edges = xbt_dynar_new(sizeof(Agedge_t*), nullptr);
156 for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
158 xbt_dynar_reset(edges);
159 for (edge = agfstout(dag_dot, node); edge; edge = agnxtout(dag_dot, edge))
160 xbt_dynar_push_as(edges, Agedge_t *, edge);
162 /* Be sure edges are sorted */
163 xbt_dynar_sort(edges, edge_compare);
165 xbt_dynar_foreach(edges, i, edge) {
166 char *src_name=agnameof(agtail(edge));
167 char *dst_name=agnameof(aghead(edge));
168 double size = atof(agget(edge, (char *) "size"));
170 SD_task_t src = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, src_name));
171 SD_task_t dst = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, dst_name));
174 char *name = bprintf("%s->%s", src_name, dst_name);
175 XBT_DEBUG("See <transfer id=%s amount = %.0f>", name, size);
176 task = static_cast<SD_task_t>(xbt_dict_get_or_null(jobs, name));
177 if (task == nullptr) {
178 if (seq_or_par == sequential)
179 task = SD_task_create_comm_e2e(name, nullptr , size);
181 task = SD_task_create_comm_par_mxn_1d_block(name, nullptr , size);
182 SD_task_dependency_add(nullptr, nullptr, src, task);
183 SD_task_dependency_add(nullptr, nullptr, task, dst);
184 xbt_dict_set(jobs, name, task, nullptr);
185 xbt_dynar_push(result, &task);
187 XBT_WARN("Task '%s' is defined more than once", name);
191 SD_task_dependency_add(nullptr, nullptr, src, dst);
195 xbt_dynar_free(&edges);
197 XBT_DEBUG("All tasks have been created, put %s at the end of the dynar", end->name);
198 xbt_dynar_push(result, &end);
200 /* Connect entry tasks to 'root', and exit tasks to 'end'*/
201 xbt_dynar_foreach (result, i, task){
202 if (task->predecessors->empty() && task->inputs->empty() && task != root) {
203 XBT_DEBUG("Task '%s' has no source. Add dependency from 'root'", task->name);
204 SD_task_dependency_add(nullptr, nullptr, root, task);
207 if (task->successors->empty() && task->outputs->empty() && task != end) {
208 XBT_DEBUG("Task '%s' has no destination. Add dependency to 'end'", task->name);
209 SD_task_dependency_add(nullptr, nullptr, task, end);
214 xbt_dict_free(&jobs);
219 if (schedule_success) {
220 const sg_host_t *workstations = sg_host_list ();
221 xbt_dict_foreach(computers,dict_cursor,computer_name,computer){
222 SD_task_t previous_task = nullptr;
223 xbt_dynar_foreach(computer, i, task){
224 /* add dependency between the previous and the task to avoid parallel execution */
226 if(previous_task && !SD_task_dependency_exists(previous_task, task))
227 SD_task_dependency_add(nullptr, nullptr, previous_task, task);
229 SD_task_schedulel(task, 1, workstations[atoi(computer_name)]);
230 previous_task = task;
233 xbt_dynar_free(&computer);
235 xbt_dict_free(&computers);
237 XBT_WARN("The scheduling is ignored");
238 xbt_dict_foreach(computers,dict_cursor,computer_name,computer)
239 xbt_dynar_free(&computer);
240 xbt_dict_free(&computers);
241 xbt_dynar_free(&result);
246 if (result && !acyclic_graph_detail(result)) {
247 char* base = xbt_basename(filename);
248 XBT_ERROR("The DOT described in %s is not a DAG. It contains a cycle.", base);
250 xbt_dynar_free(&result);
256 xbt_dynar_t SD_dotload(const char *filename) {
257 xbt_die("SD_dotload_generic() is not usable because graphviz was not found.\n"
258 "Please install graphviz, graphviz-dev, and libgraphviz-dev (and erase CMakeCache.txt) before recompiling.");
260 xbt_dynar_t SD_dotload_with_sched(const char *filename) {
261 return SD_dotload(filename);
263 xbt_dynar_t SD_PTG_dotload(const char * filename) {
264 return SD_dotload(filename);