docs/source/Plugins.rst

   1 .. _plugins:
   2
   3 SimGrid Plugins
   4 ###############
   5
   6 .. raw:: html
   7
   8    <object id="TOC" data="graphical-toc.svg" width="100%" type="image/svg+xml"></object>
   9    <script>
  10    window.onload=function() { // Wait for the SVG to be loaded before changing it
  11      var elem=document.querySelector("#TOC").contentDocument.getElementById("PluginsBox")
  12      elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
  13    }
  14    </script>
  15    <br/>
  16    <br/>
  17
  18 You can extend SimGrid without modifying it, thanks to our plugin
  19 mechanism. This page describes how to write your own plugin, and
  20 documents some of the plugins distributed with SimGrid.
  21
  22   - :ref:`Host Energy <plugin_host_energy>`: models the energy dissipation of the compute units.
  23   - :ref:`Link Energy <plugin_link_energy>`: models the energy dissipation of the network.
  24   - :ref:`Host Load <plugin_host_load>`: monitors the load of the compute units.
  25
  26 Defining a Plugin
  27 *****************
  28
  29 A plugin can get some additional code executed within the SimGrid
  30 kernel, and attach the data needed by that code to the SimGrid
  31 objects.
  32
  33 The host load plugin in
  34 `src/plugins/host_load.cpp <https://framagit.org/simgrid/simgrid/tree/master/src/plugins/host_load.cpp>`_
  35 constitutes a good introductory example. It defines a class
  36 ```HostLoad``` that is meant to be attached to each host. This class
  37 contains a ```EXTENSION_ID``` field that is mandatory to our extension
  38 mechanism. Then, the function ```sg_host_load_plugin_init```
  39 initializes the plugin. It first calls
  40 :cpp:func:`simgrid::s4u::Host::extension_create()` to register its
  41 extension to the ```s4u::Host``` objects, and then attaches some
  42 callbacks to signals.
  43
  44 You can attach your own extension to most kinds of s4u object:
  45 :cpp:class:`Actors <simgrid::s4u::Actor>`,
  46 :cpp:class:`Disks <simgrid::s4u::Disk>`,
  47 :cpp:class:`Hosts <simgrid::s4u::Host>` and
  48 :cpp:class:`Links <simgrid::s4u::Link>`. If you need to extend another
  49 kind of objects, please let us now.
  50
  51 Partial list of existing signals in s4u:
  52
  53 - :cpp:member:`Actor::on_creation <simgrid::s4u::Actor::on_creation>`
  54   :cpp:member:`Actor::on_suspend <simgrid::s4u::Actor::on_suspend>`
  55   :cpp:member:`Actor::on_resume <simgrid::s4u::Actor::on_resume>`
  56   :cpp:member:`Actor::on_sleep <simgrid::s4u::Actor::on_sleep>`
  57   :cpp:member:`Actor::on_wake_up <simgrid::s4u::Actor::on_wake_up>`
  58   :cpp:member:`Actor::on_migration_start <simgrid::s4u::Actor::on_migration_start>`
  59   :cpp:member:`Actor::on_migration_end <simgrid::s4u::Actor::on_migration_end>`
  60   :cpp:member:`Actor::on_termination <simgrid::s4u::Actor::on_termination>`
  61   :cpp:member:`Actor::on_destruction <simgrid::s4u::Actor::on_destruction>`
  62 - :cpp:member:`Comm::on_sender_start <simgrid::s4u::Comm::on_sender_start>`
  63   :cpp:member:`Comm::on_receiver_start <simgrid::s4u::Comm::on_receiver_start>`
  64   :cpp:member:`Comm::on_completion <simgrid::s4u::Comm::on_completion>`
  65 - :cpp:member:`Engine::on_platform_creation <simgrid::s4u::Engine::on_platform_creation>`
  66   :cpp:member:`Engine::on_platform_created <simgrid::s4u::Engine::on_platform_created>`
  67   :cpp:member:`Engine::on_time_advance <simgrid::s4u::Engine::on_time_advance>`
  68   :cpp:member:`Engine::on_simulation_end <simgrid::s4u::Engine::on_simulation_end>`
  69   :cpp:member:`Engine::on_deadlock <simgrid::s4u::Engine::on_deadlock>`
  70 - :cpp:member:`Exec::on_start <simgrid::s4u::Exec::on_start>`
  71   :cpp:member:`Exec::on_completion <simgrid::s4u::Exec::on_completion>`
  72 - :cpp:member:`Host::on_creation <simgrid::s4u::Host::on_creation>`
  73   :cpp:member:`Host::on_destruction <simgrid::s4u::Host::on_destruction>`
  74   :cpp:member:`Host::on_state_change <simgrid::s4u::Host::on_state_change>`
  75   :cpp:member:`Host::on_speed_change <simgrid::s4u::Host::on_speed_change>`
  76 - :cpp:member:`Link::on_creation <simgrid::s4u::Link::on_creation>`
  77   :cpp:member:`Link::on_destruction <simgrid::s4u::Link::on_destruction>`
  78   :cpp:member:`Link::on_state_change <simgrid::s4u::Link::on_state_change>`
  79   :cpp:member:`Link::on_speed_change <simgrid::s4u::Link::on_bandwidth_change>`
  80   :cpp:member:`Link::on_communicate <simgrid::s4u::Link::on_communicate>`
  81   :cpp:member:`Link::on_communication_state_change <simgrid::s4u::Link::on_communication_state_change>`
  82 - :cpp:member:`Netzone::on_creation <simgrid::s4u::Netzone::on_creation>`
  83   :cpp:member:`Netzone::on_seal <simgrid::s4u::Netzone::on_seal>`
  84   :cpp:member:`Netzone::on_route_creation <simgrid::s4u::Netzone::on_route_creation>`
  85 - :cpp:member:`VirtualMachine::on_start <simgrid::s4u::VirtualMachine::on_start>`
  86   :cpp:member:`VirtualMachine::on_started <simgrid::s4u::VirtualMachine::on_started>`
  87   :cpp:member:`VirtualMachine::on_suspend <simgrid::s4u::VirtualMachine::on_suspend>`
  88   :cpp:member:`VirtualMachine::on_resume <simgrid::s4u::VirtualMachine::on_resume>`
  89   :cpp:member:`VirtualMachine::on_migration_start <simgrid::s4u::VirtualMachine::on_migration_start>`
  90   :cpp:member:`VirtualMachine::on_migration_end <simgrid::s4u::VirtualMachine::on_migration_end>`
  91
  92 Existing Plugins
  93 ****************
  94
  95 Only the major plugins are described here. Please check in src/plugins
  96 to explore the other ones.
  97
  98 .. _plugin_host_energy:
  99
 100 Host Energy Plugin
 101 ==================
 102
 103 .. doxygengroup:: Plugin_host_energy
 104
 105 .. _plugin_link_energy:
 106
 107 Link Energy Plugin
 108 ==================
 109
 110 .. doxygengroup:: Plugin_link_energy
 111
 112 .. _plugin_host_load:
 113
 114 Host Load Plugin
 115 ================
 116
 117 .. doxygengroup:: Plugin_host_load
 118
 119 ..  LocalWords:  SimGrid