\mathcal{E} = {e_i,j | (i,j) \in {1, ..., V} x {1, ..., V}}
-.. image:: /tuto_dag/img/dag.svg
+.. image:: /img/dag.svg
:align: center
Representing Vertices/Activities
An activity will not start until all of its dependencies have been completed.
Activities may have any number of successors.
-Dependencies between Activities are created using :cpp:func:`Activity::add_successor(ActivityPtr)`.
+Dependencies between Activities are created using :cpp:func:`simgrid::s4u::Activity::add_successor`.
.. code-block:: cpp
The goal of this lab is to describe the following DAG:
-.. image:: /tuto_dag/img/dag1.svg
+.. image:: /img/dag1.svg
:align: center
In this DAG we want ``c1`` to compute 1e9 flops, ``c2`` to compute 5e9 flops and ``c3`` to compute 2e9 flops.
First of all, include the Simgrid library and define the log category.
-.. code-block:: cpp
-
- #include "simgrid/s4u.hpp"
-
- XBT_LOG_NEW_DEFAULT_CATEGORY(main, "Messages specific for this s4u tutorial");
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 6-8
Inside the ``main`` function create an instance of :ref:`Engine <API_s4u_Engine>` and load the platform.
-.. code-block:: cpp
-
- simgrid::s4u::Engine e(&argc, argv);
- e.load_platform(argv[1]);
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 12-13
Retrieve pointers to some hosts.
-.. code-block:: cpp
-
- simgrid::s4u::Host* tremblay = e.host_by_name("Tremblay");
- simgrid::s4u::Host* jupiter = e.host_by_name("Jupiter");
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 15-16
Initiate the activities.
-.. code-block:: cpp
-
- simgrid::s4u::ExecPtr c1 = simgrid::s4u::Exec::init();
- simgrid::s4u::ExecPtr c2 = simgrid::s4u::Exec::init();
- simgrid::s4u::ExecPtr c3 = simgrid::s4u::Exec::init();
- simgrid::s4u::CommPtr t1 = simgrid::s4u::Comm::sendto_init();
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 18-21
Give names to thoses activities.
-.. code-block:: cpp
-
- c1->set_name("c1");
- c2->set_name("c2");
- c3->set_name("c3");
- t1->set_name("t1");
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 23-26
Set the amount of work for each activity.
-.. code-block:: cpp
-
- c1->set_flops_amount(1e9);
- c2->set_flops_amount(5e9);
- c3->set_flops_amount(2e9);
- t1->set_payload_size(5e8);
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 28-31
Define the dependencies between the activities.
-.. code-block:: cpp
-
- c1->add_successor(t1);
- t1->add_successor(c3);
- c2->add_successor(c3);
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 33-35
Set the location of each Exec activity and source and destination for the Comm activity.
-.. code-block:: cpp
-
- c1->set_host(tremblay);
- c2->set_host(jupiter);
- c3->set_host(jupiter);
- t1->set_source(tremblay);
- t1->set_destination(jupiter);
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 37-41
Start the executions of Activities without dependencies.
-.. code-block:: cpp
-
- c1->start();
- c2->start();
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 43-44
Add a callback to monitor the activities.
-.. code-block:: cpp
-
- Activity::on_completion_cb([](simgrid::s4u::Activity const& activity) {
- XBT_INFO("Activity '%s' is complete (start time: %f, finish time: %f)", activity.get_cname(), activity.get_start_time(),
- activity.get_finish_time());
- });
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 46-49
Finally, run the simulation.
-.. code-block:: cpp
-
- e.run();
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.cpp
+ :language: cpp
+ :lines: 51
The execution of this code should give you the following output:
-.. code-block:: bash
-
- [10.194200] [main/INFO] Activity 'c1' is complete (start time: 0.000000, finish time: 10.194200)
- [65.534235] [main/INFO] Activity 'c2' is complete (start time: 0.000000, finish time: 65.534235)
- [85.283378] [main/INFO] Activity 't1' is complete (start time: 10.194200, finish time: 85.283378)
- [111.497072] [main/INFO] Activity 'c3' is complete (start time: 85.283378, finish time: 111.497072)
-
+.. literalinclude:: ../../examples/cpp/dag-tuto/s4u-dag-tuto.tesh
+ :language: none
+ :lines: 4-
Lab 2: Import a DAG from a file
----------------
+-------------------------------
In this lab we present how to import a DAG into you Simgrid simulation, either using a DOT file, a JSON file, or a DAX file.
The files presented in this lab describe the following DAG:
-.. image:: /tuto_dag/img/dag2.svg
+.. image:: /img/dag2.svg
:align: center
From a DOT file
The following DOT file describes the workflow presented at the beginning of this lab:
-.. code-block:: xml
-
- digraph G {
- c1 [size="1e9"];
- c2 [size="5e9"];
- c3 [size="2e9"];
+.. literalinclude:: ../../examples/cpp/dag-from-dot-simple/dag.dot
+ :language: dot
- root->c1 [size="2e8"];
- root->c2 [size="1e8"];
- c1->c3 [size="5e8"];
- c2->c3 [size="-1"];
- c3->end [size="2e8"];
- }
+It can be imported as a vector of Activities into Simgrid using :cpp:func:`simgrid::s4u::create_DAG_from_DOT`. Then, you have to assign hosts to your Activities.
-It can be imported as a vector of Activities into Simgrid using :cpp:func:`create_DAG_from_DOT(const std::string& filename)`. Then, you have to assign hosts to your Activities.
-
-.. code-block:: cpp
-
- #include "simgrid/s4u.hpp"
-
- XBT_LOG_NEW_DEFAULT_CATEGORY(main, "Messages specific for this s4u example");
-
- int main(int argc, char* argv[]) {
- simgrid::s4u::Engine e(&argc, argv);
- e.load_platform(argv[1]);
-
- std::vector<simgrid::s4u::ActivityPtr> dag = simgrid::s4u::create_DAG_from_dot(argv[2]);
-
- simgrid::s4u::Host* tremblay = e.host_by_name("Tremblay");
- simgrid::s4u::Host* jupiter = e.host_by_name("Jupiter");
- simgrid::s4u::Host* fafard = e.host_by_name("Fafard");
-
- dynamic_cast<simgrid::s4u::Exec*>(dag[0].get())->set_host(fafard);
- dynamic_cast<simgrid::s4u::Exec*>(dag[1].get())->set_host(tremblay);
- dynamic_cast<simgrid::s4u::Exec*>(dag[2].get())->set_host(jupiter);
- dynamic_cast<simgrid::s4u::Exec*>(dag[3].get())->set_host(jupiter);
- dynamic_cast<simgrid::s4u::Exec*>(dag[8].get())->set_host(jupiter);
-
- for (const auto& a : dag) {
- if (auto* comm = dynamic_cast<simgrid::s4u::Comm*>(a.get())) {
- auto pred = dynamic_cast<simgrid::s4u::Exec*>((*comm->get_dependencies().begin()).get());
- auto succ = dynamic_cast<simgrid::s4u::Exec*>(comm->get_successors().front().get());
- comm->set_source(pred->get_host())->set_destination(succ->get_host());
- }
- }
-
- simgrid::s4u::Activity::on_completion_cb([](simgrid::s4u::Activity const& activity) {
- XBT_INFO("Activity '%s' is complete (start time: %f, finish time: %f)", activity.get_cname(), activity.get_start_time(),
- activity.get_finish_time());
- });
-
- e.run();
- return 0;
- }
+.. literalinclude:: ../../examples/cpp/dag-from-dot-simple/s4u-dag-from-dot-simple.cpp
+ :language: cpp
The execution of this code should give you the following output:
-.. code-block:: bash
-
- [0.000000] [main/INFO] Activity 'root' is complete (start time: 0.000000, finish time: 0.000000)
- [33.394394] [main/INFO] Activity 'root->c2' is complete (start time: 0.000000, finish time: 33.394394)
- [39.832311] [main/INFO] Activity 'root->c1' is complete (start time: 0.000000, finish time: 39.832311)
- [50.026511] [main/INFO] Activity 'c1' is complete (start time: 39.832311, finish time: 50.026511)
- [98.928629] [main/INFO] Activity 'c2' is complete (start time: 33.394394, finish time: 98.928629)
- [125.115689] [main/INFO] Activity 'c1->c3' is complete (start time: 50.026511, finish time: 125.115689)
- [151.329383] [main/INFO] Activity 'c3' is complete (start time: 125.115689, finish time: 151.329383)
- [151.743605] [main/INFO] Activity 'c3->end' is complete (start time: 151.329383, finish time: 151.743605)
- [151.743605] [main/INFO] Activity 'end' is complete (start time: 151.743605, finish time: 151.743605)
+.. literalinclude:: ../../examples/cpp/dag-from-dot-simple/s4u-dag-from-dot-simple.tesh
+ :language: none
+ :lines: 4-
From a JSON file
................
The following JSON file describes the workflow presented at the beginning of this lab:
-.. code-block:: JSON
-
- {
- "name": "simple_json",
- "schemaVersion": "1.0",
- "workflow": {
- "makespan": 0,
- "executedAt": "2023-03-09T00:00:00-00:00",
- "tasks": [
- {
- "name": "c1",
- "type": "compute",
- "parents": [],
- "runtime": 1e9,
- "machine": "Tremblay"
- },
- {
- "name": "t1",
- "type": "transfer",
- "parents": ["c1"],
- "bytesWritten": 5e8,
- "machine": "Jupiter"
- },
- {
- "name": "c2",
- "type": "compute",
- "parents": [],
- "runtime": 5e9,
- "machine": "Jupiter"
- },
- {
- "name": "c3",
- "type": "compute",
- "parents": ["t1","c2"],
- "runtime": 2e9,
- "machine": "Jupiter"
- }
- ],
- "machines": [
- {"nodeName": "Tremblay"},
- {"nodeName": "Jupiter"}
- ]
- }
- }
-
-It can be imported as a vector of Activities into Simgrid using :cpp:func:`create_DAG_from_json(const std::string& filename)`.
-
-.. code-block:: cpp
-
- #include "simgrid/s4u.hpp"
+.. literalinclude:: ../../examples/cpp/dag-from-json-simple/dag.json
+ :language: json
- XBT_LOG_NEW_DEFAULT_CATEGORY(main, "Messages specific for this s4u example");
+It can be imported as a vector of Activities into Simgrid using :cpp:func:`simgrid::s4u::create_DAG_from_json`.
- int main(int argc, char* argv[]) {
- simgrid::s4u::Engine e(&argc, argv);
- e.load_platform(argv[1]);
-
- std::vector<simgrid::s4u::ActivityPtr> dag = simgrid::s4u::create_DAG_from_json(argv[2]);
-
- simgrid::s4u::Activity::on_completion_cb([](simgrid::s4u::Activity const& activity) {
- XBT_INFO("Activity '%s' is complete (start time: %f, finish time: %f)", activity.get_cname(), activity.get_start_time(),
- activity.get_finish_time());
- });
-
- e.run();
- return 0;
- }
+.. literalinclude:: ../../examples/cpp/dag-from-json-simple/s4u-dag-from-json-simple.cpp
+ :language: cpp
The execution of this code should give you the following output:
-.. code-block:: bash
-
- [10.194200] [main/INFO] Activity 'c1' is complete (start time: 0.000000, finish time: 10.194200)
- [65.534235] [main/INFO] Activity 'c2' is complete (start time: 0.000000, finish time: 65.534235)
- [85.283378] [main/INFO] Activity 't1' is complete (start time: 10.194200, finish time: 85.283378)
- [111.497072] [main/INFO] Activity 'c3' is complete (start time: 85.283378, finish time: 111.497072)
+.. literalinclude:: ../../examples/cpp/dag-from-json-simple/s4u-dag-from-json-simple.tesh
+ :language: none
+ :lines: 4-
From a DAX file [deprecated]
............................
The following DAX file describes the workflow presented at the beginning of this lab:
-.. code-block:: xml
-
- <?xml version="1.0" encoding="UTF-8"?>
- <adag xmlns="http://pegasus.isi.edu/schema/DAX" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pegasus.isi.edu/schema/DAX http://pegasus.isi.edu/schema/dax-2.1.xsd"
- version="2.1">
- <job id="1" name="c1" runtime="10">
- <uses file="i1" link="input" register="true" transfer="true" optional="false" type="data" size="2e8"/>
- <uses file="o1" link="output" register="true" transfer="true" optional="false" type="data" size="5e8"/>
- </job>
- <job id="2" name="c2" runtime="50">
- <uses file="i2" link="input" register="true" transfer="true" optional="false" type="data" size="1e8"/>
- </job>
- <job id="3" name="c3" runtime="20">
- <uses file="o1" link="input" register="true" transfer="true" optional="false" type="data" size="5e8"/>
- <uses file="o3" link="output" register="true" transfer="true" optional="false" type="data" size="2e8"/>
- </job>
- <child ref="3">
- <parent ref="1"/>
- <parent ref="2"/>
- </child>
- </adag>
-
-It can be imported as a vector of Activities into Simgrid using :cpp:func:`create_DAG_from_DAX(std::string)`.
-
-.. code-block:: cpp
-
- #include "simgrid/s4u.hpp"
-
- XBT_LOG_NEW_DEFAULT_CATEGORY(main, "Messages specific for this s4u example");
-
- int main(int argc, char* argv[]) {
- simgrid::s4u::Engine e(&argc, argv);
- e.load_platform(argv[1]);
-
- std::vector<simgrid::s4u::ActivityPtr> dag = simgrid::s4u::create_DAG_from_DAX(argv[2]);
-
- simgrid::s4u::Host* tremblay = e.host_by_name("Tremblay");
- simgrid::s4u::Host* jupiter = e.host_by_name("Jupiter");
- simgrid::s4u::Host* fafard = e.host_by_name("Fafard");
-
- dynamic_cast<simgrid::s4u::Exec*>(dag[0].get())->set_host(fafard);
- dynamic_cast<simgrid::s4u::Exec*>(dag[1].get())->set_host(tremblay);
- dynamic_cast<simgrid::s4u::Exec*>(dag[2].get())->set_host(jupiter);
- dynamic_cast<simgrid::s4u::Exec*>(dag[3].get())->set_host(jupiter);
- dynamic_cast<simgrid::s4u::Exec*>(dag[8].get())->set_host(jupiter);
-
- for (const auto& a : dag) {
- if (auto* comm = dynamic_cast<simgrid::s4u::Comm*>(a.get())) {
- auto pred = dynamic_cast<simgrid::s4u::Exec*>((*comm->get_dependencies().begin()).get());
- auto succ = dynamic_cast<simgrid::s4u::Exec*>(comm->get_successors().front().get());
- comm->set_source(pred->get_host())->set_destination(succ->get_host());
- }
- }
-
- simgrid::s4u::Activity::on_completion_cb([](simgrid::s4u::Activity const& activity) {
- XBT_INFO("Activity '%s' is complete (start time: %f, finish time: %f)", activity.get_cname(), activity.get_start_time(),
- activity.get_finish_time());
- });
+.. literalinclude:: ../../examples/cpp/dag-from-dax-simple/dag.xml
+ :language: xml
- e.run();
- return 0;
- }
+It can be imported as a vector of Activities into Simgrid using :cpp:func:`simgrid::s4u::create_DAG_from_DAX`.
+.. literalinclude:: ../../examples/cpp/dag-from-dax-simple/s4u-dag-from-dax-simple.cpp
+ :language: cpp
