docs/source/Plugins.rst

   1 .. _plugins:
   2
   3 SimGrid Plugins
   4 ###############
   5
   6 .. raw:: html
   7
   8    <object id="TOC" data="graphical-toc.svg" 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 Load <plugin_host_load>`: monitors the load of the compute units.
  23   - :ref:`Host Energy <plugin_host_energy>`: models the energy dissipation of the compute units.
  24   - :ref:`Link Energy <plugin_link_energy>`: models the energy dissipation of the network.
  25   - :ref:`WiFi Energy <plugin_link_energy_wifi>`: models the energy dissipation of wifi links.
  26
  27 You can activate these plugins with the :ref:`--cfg=plugin <cfg=plugin>` command
  28 line option, for example with ``--cfg=plugin:host_energy``. You can get the full
  29 list of existing plugins with ``--cfg=plugin:help``.
  30
  31 Defining a Plugin
  32 *****************
  33
  34 A plugin can get some additional code executed within the SimGrid
  35 kernel, and attach the data needed by that code to the SimGrid
  36 objects.
  37
  38 The host load plugin in
  39 `src/plugins/host_load.cpp <https://framagit.org/simgrid/simgrid/tree/master/src/plugins/host_load.cpp>`_
  40 constitutes a good introductory example. It defines a class
  41 ``HostLoad`` that is meant to be attached to each host. This class
  42 contains a ``EXTENSION_ID`` field that is mandatory to our extension
  43 mechanism. Then, the function ``sg_host_load_plugin_init``
  44 initializes the plugin. It first calls
  45 :cpp:func:`simgrid::s4u::Host::extension_create()` to register its
  46 extension to the ``s4u::Host`` objects, and then attaches some
  47 callbacks to signals.
  48
  49 You can attach your own extension to most kinds of s4u object:
  50 :cpp:class:`Actors <simgrid::s4u::Actor>`,
  51 :cpp:class:`Disks <simgrid::s4u::Disk>`,
  52 :cpp:class:`Hosts <simgrid::s4u::Host>` and
  53 :cpp:class:`Links <simgrid::s4u::Link>`. If you need to extend another
  54 kind of objects, please let us now.
  55
  56 .. cpp:class:: template<class R, class... P> simgrid::xbt::signal<R(P...)>
  57
  58   A signal/slot mechanism, where you can attach callbacks to a given signal, and then fire the signal.
  59
  60   The template parameter is the function signature of the signal (the return value currently ignored).
  61
  62 .. cpp:function::: template<class R, class... P, class U>  unsigned int simgrid::xbt::signal<R(P...)>::connect(U slot)
  63
  64   Add a new callback to this signal.
  65
  66 .. cpp:function:: template<class R, class... P> simgrid::xbt::signal<R(P...)>::operator()(P... args)
  67
  68   Fire that signal, invoking all callbacks.
  69
  70 Partial list of existing signals in s4u:
  71
  72 - :cpp:member:`Actor::on_creation <simgrid::s4u::Actor::on_creation>`
  73   :cpp:member:`Actor::on_suspend <simgrid::s4u::Actor::on_suspend>`
  74   :cpp:member:`Actor::on_resume <simgrid::s4u::Actor::on_resume>`
  75   :cpp:member:`Actor::on_sleep <simgrid::s4u::Actor::on_sleep>`
  76   :cpp:member:`Actor::on_wake_up <simgrid::s4u::Actor::on_wake_up>`
  77   :cpp:member:`Actor::on_host_change <simgrid::s4u::Actor::on_host_change>`
  78   :cpp:member:`Actor::on_termination <simgrid::s4u::Actor::on_termination>`
  79   :cpp:member:`Actor::on_destruction <simgrid::s4u::Actor::on_destruction>`
  80 - :cpp:member:`Comm::on_start <simgrid::s4u::Comm::on_start>`
  81   :cpp:member:`Comm::on_completion <simgrid::s4u::Comm::on_completion>`
  82 - :cpp:member:`Engine::on_platform_creation <simgrid::s4u::Engine::on_platform_creation>`
  83   :cpp:member:`Engine::on_platform_created <simgrid::s4u::Engine::on_platform_created>`
  84   :cpp:member:`Engine::on_time_advance <simgrid::s4u::Engine::on_time_advance>`
  85   :cpp:member:`Engine::on_simulation_end <simgrid::s4u::Engine::on_simulation_end>`
  86   :cpp:member:`Engine::on_deadlock <simgrid::s4u::Engine::on_deadlock>`
  87 - :cpp:member:`Comm::on_start <simgrid::s4u::Comm::on_start>`
  88   :cpp:member:`Comm::on_completion <simgrid::s4u::Comm::on_completion>`
  89 - :cpp:member:`Exec::on_start <simgrid::s4u::Exec::on_start>`
  90   :cpp:member:`Exec::on_completion <simgrid::s4u::Exec::on_completion>`
  91 - :cpp:member:`Exec::on_start <simgrid::s4u::Exec::on_start>`
  92   :cpp:member:`Exec::on_completion <simgrid::s4u::Exec::on_completion>`
  93 - :cpp:member:`Host::on_creation <simgrid::s4u::Host::on_creation>`
  94   :cpp:member:`Host::on_destruction <simgrid::s4u::Host::on_destruction>`
  95   :cpp:member:`Host::on_state_change <simgrid::s4u::Host::on_state_change>`
  96   :cpp:member:`Host::on_speed_change <simgrid::s4u::Host::on_speed_change>`
  97 - :cpp:member:`Link::on_creation <simgrid::s4u::Link::on_creation>`
  98   :cpp:member:`Link::on_destruction <simgrid::s4u::Link::on_destruction>`
  99   :cpp:member:`Link::on_state_change <simgrid::s4u::Link::on_state_change>`
 100   :cpp:member:`Link::on_speed_change <simgrid::s4u::Link::on_bandwidth_change>`
 101   :cpp:member:`Link::on_communication_state_change <simgrid::s4u::Link::on_communication_state_change>`
 102 - :cpp:member:`NetZone::on_creation <simgrid::s4u::NetZone::on_creation>`
 103   :cpp:member:`NetZone::on_seal <simgrid::s4u::NetZone::on_seal>`
 104 - :cpp:member:`VirtualMachine::on_start <simgrid::s4u::VirtualMachine::on_start>`
 105   :cpp:member:`VirtualMachine::on_started <simgrid::s4u::VirtualMachine::on_started>`
 106   :cpp:member:`VirtualMachine::on_suspend <simgrid::s4u::VirtualMachine::on_suspend>`
 107   :cpp:member:`VirtualMachine::on_resume <simgrid::s4u::VirtualMachine::on_resume>`
 108   :cpp:member:`VirtualMachine::on_migration_start <simgrid::s4u::VirtualMachine::on_migration_start>`
 109   :cpp:member:`VirtualMachine::on_migration_end <simgrid::s4u::VirtualMachine::on_migration_end>`
 110
 111 Existing Plugins
 112 ****************
 113
 114 Only the major plugins are described here. Please check in src/plugins
 115 to explore the other ones.
 116
 117 .. _plugin_host_energy:
 118
 119 Host Energy
 120 ===========
 121
 122 .. doxygengroup:: plugin_host_energy
 123
 124
 125
 126 .. _plugin_link_energy:
 127
 128 Link Energy
 129 ===========
 130
 131 .. doxygengroup:: plugin_link_energy
 132
 133 .. _plugin_link_energy_wifi:
 134
 135 WiFi Energy
 136 ===========
 137
 138 .. doxygengroup:: plugin_link_energy_wifi
 139
 140
 141
 142 .. _plugin_host_load:
 143
 144 Host Load
 145 =========
 146
 147 .. doxygengroup:: plugin_host_load
 148
 149
 150
 151 .. _plugin_filesystem:
 152
 153 File System
 154 ===========
 155
 156 .. doxygengroup:: plugin_filesystem
 157
 158
 159 ..  LocalWords:  SimGrid