src/dag/loaders.cpp

   1 /* Copyright (c) 2009-2023. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/internal_config.h"
   7 #include <algorithm>
   8 #include <map>
   9 #include <fstream>
  10 #include <simgrid/s4u/Host.hpp>
  11 #include <simgrid/s4u/Comm.hpp>
  12 #include <simgrid/s4u/Engine.hpp>
  13 #include <simgrid/s4u/Exec.hpp>
  14 #include <stdexcept>
  15 #include <xbt/asserts.h>
  16 #include <xbt/file.hpp>
  17 #include <xbt/log.h>
  18 #include <xbt/misc.h>
  19
  20 #include "dax_dtd.h"
  21 #include "dax_dtd.c"
  22
  23 #if SIMGRID_HAVE_JSON
  24 #include <nlohmann/json.hpp>
  25 #endif
  26
  27 #if HAVE_GRAPHVIZ
  28 #include <graphviz/cgraph.h>
  29 #endif
  30
  31 XBT_LOG_NEW_DEFAULT_CATEGORY(dag_parsing, "Generation DAGs from files");
  32
  33 /* Ensure that transfer tasks have unique names even though a file is used several times */
  34 static void uniq_transfer_task_name(simgrid::s4u::Comm* comm)
  35 {
  36   const auto& child  = comm->get_successors().front();
  37   const auto& parent = *(comm->get_dependencies().begin());
  38
  39   std::string new_name = parent->get_name() + "_" + comm->get_name() + "_" + child->get_name();
  40
  41   comm->set_name(new_name)->start();
  42 }
  43
  44 static bool check_for_cycle(const std::vector<simgrid::s4u::ActivityPtr>& dag)
  45 {
  46   std::vector<simgrid::s4u::ActivityPtr> current;
  47
  48   std::copy_if(begin(dag), end(dag), back_inserter(current), [](const auto& a) {
  49     return dynamic_cast<simgrid::s4u::Exec*>(a.get()) != nullptr && a->has_no_successor();
  50   });
  51
  52   while (not current.empty()) {
  53     std::vector<simgrid::s4u::ActivityPtr> next;
  54     for (auto const& a : current) {
  55       a->mark();
  56       for (auto const& pred : a->get_dependencies()) {
  57         if (dynamic_cast<simgrid::s4u::Comm*>(pred.get()) != nullptr) {
  58           pred->mark();
  59           // Comms have only one predecessor
  60           auto pred_pred = *(pred->get_dependencies().begin());
  61           if (std::none_of(pred_pred->get_successors().begin(), pred_pred->get_successors().end(),
  62                            [](const simgrid::s4u::ActivityPtr& act) { return not act->is_marked(); }))
  63             next.push_back(pred_pred);
  64         } else {
  65           if (std::none_of(pred->get_successors().begin(), pred->get_successors().end(),
  66                            [](const simgrid::s4u::ActivityPtr& act) { return not act->is_marked(); }))
  67             next.push_back(pred);
  68         }
  69       }
  70     }
  71     current.clear();
  72     current = next;
  73   }
  74
  75   return not std::any_of(dag.begin(), dag.end(), [](const simgrid::s4u::ActivityPtr& a) { return not a->is_marked(); });
  76 }
  77
  78 static YY_BUFFER_STATE input_buffer;
  79
  80 namespace simgrid::s4u {
  81
  82 static std::vector<ActivityPtr> result;
  83 static std::map<std::string, ExecPtr, std::less<>> jobs;
  84 static std::map<std::string, Comm*, std::less<>> files;
  85 static ExecPtr current_job;
  86
  87 /** @brief loads a JSON file describing a DAG
  88  *
  89  * See https://github.com/wfcommons/wfformat for more details.
  90  */
  91 std::vector<ActivityPtr> create_DAG_from_json(const std::string& filename)
  92 {
  93 #if SIMGRID_HAVE_JSON
  94   std::ifstream f(filename);
  95   auto data = nlohmann::json::parse(f);
  96   std::vector<ActivityPtr> dag = {};
  97   std::map<std::string, std::vector<ActivityPtr>> successors = {};
  98   std::map<ActivityPtr, Host*> comms_destinations = {};
  99   ActivityPtr current;
 100
 101   for (auto const& task: data["workflow"]["tasks"]) {
 102     if (task["type"] == "compute") {
 103       current = Exec::init()->set_name(task["name"])->set_flops_amount(task["runtime"]);
 104       if (task.contains("machine"))
 105         dynamic_cast<Exec*>(current.get())->set_host(simgrid::s4u::Engine::get_instance()->host_by_name(task["machine"]));
 106     }
 107     else if (task["type"] == "transfer"){
 108       current = Comm::sendto_init()->set_name(task["name"])->set_payload_size(task["bytesWritten"]);
 109       if (task.contains("machine"))
 110         comms_destinations[current] = simgrid::s4u::Engine::get_instance()->host_by_name(task["machine"]);
 111       if (task["parents"].size() == 1) {
 112         ActivityPtr parent_activity;
 113         for (auto const& activity: dag) {
 114           if (activity->get_name() == task["parents"][0]) {
 115             parent_activity = activity;
 116             break;
 117           }
 118         }
 119         if (dynamic_cast<Exec*>(parent_activity.get()) != nullptr)
 120           dynamic_cast<Comm*>(current.get())->set_source(dynamic_cast<Exec*>(parent_activity.get())->get_host());
 121         else if (dynamic_cast<Comm*>(parent_activity.get()) != nullptr)
 122           dynamic_cast<Comm*>(current.get())->set_source(dynamic_cast<Comm*>(parent_activity.get())->get_destination());
 123       }
 124     }
 125     else
 126       XBT_DEBUG("Task type \"%s\" not supported.", task["type"]);
 127
 128     dag.push_back(current);
 129     for (auto const& parent: task["parents"]) {
 130       auto it = successors.find(parent);
 131       if (it == successors.end())
 132         successors[parent] = {};
 133       successors[parent].push_back(current);
 134     }
 135   }
 136   // Assign successors
 137   for (auto const& [parent, successors_list] : successors)
 138     for (auto const& activity: dag)
 139       if (activity->get_name() == parent) {
 140         for (auto const& successor: successors_list)
 141           activity->add_successor(successor);
 142         break;
 143       }
 144   // Assign destinations of Comms (if done before successors are assigned there is a bug)
 145   for (auto const& [comm, destination]: comms_destinations)
 146     dynamic_cast<Comm*>(comm.get())->set_destination(destination);
 147
 148   // Start only Activities with dependencies solved
 149   for (auto const& activity: dag) {
 150     if (dynamic_cast<Exec*>(activity.get()) != nullptr and activity->dependencies_solved())
 151       activity->start();
 152   }
 153   return dag;
 154 #else
 155   xbt_die("JSON support was not compiled in, probably because nlohmann/json was not found. Please install "
 156           "nlohmann-json3-dev and recompile SimGrid to use this feature.");
 157 #endif
 158 }
 159 /** @brief loads a DAX file describing a DAG
 160  *
 161  * See https://confluence.pegasus.isi.edu/display/pegasus/WorkflowGenerator for more details.
 162  */
 163 std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename)
 164 {
 165   FILE* in_file = fopen(filename.c_str(), "r");
 166   xbt_assert(in_file, "Unable to open \"%s\"\n", filename.c_str());
 167   input_buffer = dax__create_buffer(in_file, 10);
 168   dax__switch_to_buffer(input_buffer);
 169   dax_lineno = 1;
 170
 171   auto root_task = Exec::init()->set_name("root")->set_flops_amount(0);
 172   root_task->start();
 173
 174   result.push_back(root_task);
 175
 176   auto end_task = Exec::init()->set_name("end")->set_flops_amount(0);
 177   end_task->start();
 178
 179   xbt_assert(dax_lex() == 0, "Parse error in %s: %s", filename.c_str(), dax__parse_err_msg());
 180   dax__delete_buffer(input_buffer);
 181   fclose(in_file);
 182   dax_lex_destroy();
 183
 184   /* And now, post-process the files.
 185    * We want a file task per pair of computation tasks exchanging the file. Duplicate on need
 186    * Files not produced in the system are said to be produced by root task (top of DAG).
 187    * Files not consumed in the system are said to be consumed by end task (bottom of DAG).
 188    */
 189   for (auto const& [_, elm] : files) {
 190     CommPtr file = elm;
 191     CommPtr newfile;
 192     if (file->dependencies_solved()) {
 193       for (auto const& it : file->get_successors()) {
 194         newfile = Comm::sendto_init()->set_name(file->get_name())->set_payload_size(file->get_remaining());
 195         root_task->add_successor(newfile);
 196         newfile->add_successor(it);
 197         result.push_back(newfile);
 198       }
 199     }
 200     if (file->has_no_successor()) {
 201       for (auto const& it : file->get_dependencies()) {
 202         newfile = Comm::sendto_init()->set_name(file->get_name())->set_payload_size(file->get_remaining());
 203         it->add_successor(newfile);
 204         newfile->add_successor(end_task);
 205         result.push_back(newfile);
 206       }
 207     }
 208     for (auto const& it : file->get_dependencies()) {
 209       for (auto const& it2 : file->get_successors()) {
 210         if (it == it2) {
 211           XBT_WARN("File %s is produced and consumed by task %s."
 212                    "This loop dependency will prevent the execution of the task.",
 213                    file->get_cname(), it->get_cname());
 214         }
 215         newfile = Comm::sendto_init()->set_name(file->get_name())->set_payload_size(file->get_remaining());
 216         it->add_successor(newfile);
 217         newfile->add_successor(it2);
 218         result.push_back(newfile);
 219       }
 220     }
 221     /* Free previous copy of the files */
 222     file->destroy();
 223   }
 224
 225   /* Push end task last */
 226   result.push_back(end_task);
 227
 228   for (const auto& a : result) {
 229     auto* comm = dynamic_cast<Comm*>(a.get());
 230     if (comm != nullptr) {
 231       uniq_transfer_task_name(comm);
 232     } else {
 233       /* If some tasks do not take files as input, connect them to the root
 234        * if they don't produce files, connect them to the end node.
 235        */
 236       if ((a != root_task) && (a != end_task)) {
 237         if (a->dependencies_solved())
 238           root_task->add_successor(a);
 239         if (a->has_no_successor())
 240           a->add_successor(end_task);
 241       }
 242     }
 243   }
 244
 245   if (not check_for_cycle(result)) {
 246     XBT_ERROR("The DAX described in %s is not a DAG. It contains a cycle.",
 247               simgrid::xbt::Path(filename).get_base_name().c_str());
 248     for (const auto& a : result)
 249       a->destroy();
 250     result.clear();
 251   }
 252
 253   return result;
 254 }
 255
 256 #if HAVE_GRAPHVIZ
 257 std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename)
 258 {
 259   FILE* in_file = fopen(filename.c_str(), "r");
 260   xbt_assert(in_file != nullptr, "Failed to open file: %s", filename.c_str());
 261
 262   Agraph_t* dag_dot = agread(in_file, nullptr);
 263
 264   std::unordered_map<std::string, ActivityPtr> activities;
 265   std::vector<ActivityPtr> dag;
 266
 267   ActivityPtr root;
 268   ActivityPtr end;
 269   ActivityPtr act;
 270   /* Create all the nodes */
 271   Agnode_t* node = nullptr;
 272   for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
 273     const std::string name = agnameof(node);
 274     double amount = atof(agget(node, (char*)"size"));
 275
 276     if (activities.find(name) == activities.end()) {
 277       XBT_DEBUG("See <Exec id = %s amount = %.0f>", name.c_str(), amount);
 278       act = Exec::init()->set_name(name)->set_flops_amount(amount)->start();
 279       activities.try_emplace(name, act);
 280       if (name != "root" && name != "end")
 281         dag.push_back(act);
 282     } else {
 283       XBT_WARN("Exec '%s' is defined more than once", name.c_str());
 284     }
 285   }
 286   /*Check if 'root' and 'end' nodes have been explicitly declared.  If not, create them. */
 287   if (activities.find("root") == activities.end())
 288     root = Exec::init()->set_name("root")->set_flops_amount(0)->start();
 289   else
 290     root = activities.at("root");
 291
 292   if (activities.find("end") == activities.end())
 293     end = Exec::init()->set_name("end")->set_flops_amount(0)->start();
 294   else
 295     end = activities.at("end");
 296
 297   /* Create edges */
 298   std::vector<Agedge_t*> edges;
 299   for (node = agfstnode(dag_dot); node; node = agnxtnode(dag_dot, node)) {
 300     edges.clear();
 301     for (Agedge_t* edge = agfstout(dag_dot, node); edge; edge = agnxtout(dag_dot, edge))
 302       edges.push_back(edge);
 303
 304     /* Be sure edges are sorted */
 305     std::sort(edges.begin(), edges.end(), [](const Agedge_t* a, const Agedge_t* b) { return AGSEQ(a) < AGSEQ(b); });
 306
 307     for (Agedge_t* edge : edges) {
 308       const char* src_name = agnameof(agtail(edge));
 309       const char* dst_name = agnameof(aghead(edge));
 310       double size          = atof(agget(edge, (char*)"size"));
 311
 312       ActivityPtr src = activities.at(src_name);
 313       ActivityPtr dst = activities.at(dst_name);
 314       if (size > 0) {
 315         std::string name = std::string(src_name) + "->" + dst_name;
 316         XBT_DEBUG("See <Comm id=%s amount = %.0f>", name.c_str(), size);
 317         if (activities.find(name) == activities.end()) {
 318           act = Comm::sendto_init()->set_name(name)->set_payload_size(size)->start();
 319           src->add_successor(act);
 320           act->add_successor(dst);
 321           activities.try_emplace(name, act);
 322           dag.push_back(act);
 323         } else {
 324           XBT_WARN("Comm '%s' is defined more than once", name.c_str());
 325         }
 326       } else {
 327         src->add_successor(dst);
 328       }
 329     }
 330   }
 331
 332   XBT_DEBUG("All activities have been created, put %s at the beginning and %s at the end", root->get_cname(),
 333             end->get_cname());
 334   dag.insert(dag.begin(), root);
 335   dag.push_back(end);
 336
 337   /* Connect entry tasks to 'root', and exit tasks to 'end'*/
 338   for (const auto& a : dag) {
 339     if (a->dependencies_solved() && a != root) {
 340       XBT_DEBUG("Activity '%s' has no dependencies. Add dependency from 'root'", a->get_cname());
 341       root->add_successor(a);
 342     }
 343
 344     if (a->has_no_successor() && a != end) {
 345       XBT_DEBUG("Activity '%s' has no successors. Add dependency to 'end'", a->get_cname());
 346       a->add_successor(end);
 347     }
 348   }
 349   agclose(dag_dot);
 350   fclose(in_file);
 351
 352   if (not check_for_cycle(dag)) {
 353     std::string base = simgrid::xbt::Path(filename).get_base_name();
 354     XBT_ERROR("The DOT described in %s is not a DAG. It contains a cycle.", base.c_str());
 355     for (const auto& a : dag)
 356       a->destroy();
 357     dag.clear();
 358     dag.shrink_to_fit();
 359   }
 360
 361   return dag;
 362 }
 363 #else
 364 std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename)
 365 {
 366   xbt_die("create_DAG_from_dot() is not usable because graphviz was not found.\n"
 367           "Please install graphviz, graphviz-dev, and libgraphviz-dev (and erase CMakeCache.txt) before recompiling.");
 368 }
 369 #endif
 370 } // namespace simgrid::s4u
 371
 372 void STag_dax__adag()
 373 {
 374   try {
 375     double version = std::stod(A_dax__adag_version);
 376     xbt_assert(version == 2.1, "Expected version 2.1 in <adag> tag, got %f. Fix the parser or your file", version);
 377   } catch (const std::invalid_argument&) {
 378     throw std::invalid_argument(std::string("Parse error: ") + A_dax__adag_version + " is not a double");
 379   }
 380 }
 381
 382 void STag_dax__job()
 383 {
 384   try {
 385     double runtime = std::stod(A_dax__job_runtime);
 386
 387     std::string name = std::string(A_dax__job_id) + "@" + A_dax__job_name;
 388     runtime *= 4200000000.; /* Assume that timings were done on a 4.2GFlops machine. I mean, why not? */
 389     XBT_DEBUG("See <job id=%s runtime=%s %.0f>", A_dax__job_id, A_dax__job_runtime, runtime);
 390     simgrid::s4u::current_job = simgrid::s4u::Exec::init()->set_name(name)->set_flops_amount(runtime)->start();
 391     simgrid::s4u::jobs.try_emplace(A_dax__job_id, simgrid::s4u::current_job);
 392     simgrid::s4u::result.push_back(simgrid::s4u::current_job);
 393   } catch (const std::invalid_argument&) {
 394     throw std::invalid_argument(std::string("Parse error: ") + A_dax__job_runtime + " is not a double");
 395   }
 396 }
 397
 398 void STag_dax__uses()
 399 {
 400   double size;
 401   try {
 402     size = std::stod(A_dax__uses_size);
 403   } catch (const std::invalid_argument&) {
 404     throw std::invalid_argument(std::string("Parse error: ") + A_dax__uses_size + " is not a double");
 405   }
 406   bool is_input = (A_dax__uses_link == A_dax__uses_link_input);
 407
 408   XBT_DEBUG("See <uses file=%s %s>", A_dax__uses_file, (is_input ? "in" : "out"));
 409   auto it = simgrid::s4u::files.find(A_dax__uses_file);
 410   simgrid::s4u::CommPtr file;
 411   if (it == simgrid::s4u::files.end()) {
 412     file = simgrid::s4u::Comm::sendto_init()->set_name(A_dax__uses_file)->set_payload_size(size);
 413     simgrid::s4u::files[A_dax__uses_file] = file.get();
 414   } else {
 415     file = it->second;
 416     if (file->get_remaining() < size || file->get_remaining() > size) {
 417       XBT_WARN("Ignore file %s size redefinition from %.0f to %.0f", A_dax__uses_file, file->get_remaining(), size);
 418     }
 419   }
 420   if (is_input) {
 421     file->add_successor(simgrid::s4u::current_job);
 422   } else {
 423     simgrid::s4u::current_job->add_successor(file);
 424     if (file->get_dependencies().size() > 1) {
 425       XBT_WARN("File %s created at more than one location...", file->get_cname());
 426     }
 427   }
 428 }
 429
 430 static simgrid::s4u::ExecPtr current_child;
 431 void STag_dax__child()
 432 {
 433   auto job = simgrid::s4u::jobs.find(A_dax__child_ref);
 434   if (job != simgrid::s4u::jobs.end()) {
 435     current_child = job->second;
 436   } else {
 437     throw std::out_of_range("Parse error on line " + std::to_string(dax_lineno) +
 438                             ": Asked to add dependencies to the non-existent " + A_dax__child_ref + "task");
 439   }
 440 }
 441
 442 void ETag_dax__child()
 443 {
 444   current_child = nullptr;
 445 }
 446
 447 void STag_dax__parent()
 448 {
 449   auto job = simgrid::s4u::jobs.find(A_dax__parent_ref);
 450   if (job != simgrid::s4u::jobs.end()) {
 451     auto parent = job->second;
 452     parent->add_successor(current_child);
 453     XBT_DEBUG("Control-flow dependency from %s to %s", current_child->get_cname(), parent->get_cname());
 454   } else {
 455     throw std::out_of_range("Parse error on line " + std::to_string(dax_lineno) + ": Asked to add a dependency from " +
 456                             current_child->get_name() + " to " + A_dax__parent_ref + ", but " + A_dax__parent_ref +
 457                             " does not exist");
 458   }
 459 }
 460
 461 void ETag_dax__adag()
 462 {
 463   XBT_DEBUG("See </adag>");
 464 }
 465
 466 void ETag_dax__job()
 467 {
 468   simgrid::s4u::current_job = nullptr;
 469   XBT_DEBUG("See </job>");
 470 }
 471
 472 void ETag_dax__parent()
 473 {
 474   XBT_DEBUG("See </parent>");
 475 }
 476
 477 void ETag_dax__uses()
 478 {
 479   XBT_DEBUG("See </uses>");
 480 }