8 <object id="TOC" data="graphical-toc.svg" type="image/svg+xml"></object>
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";
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:
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.
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``.
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
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
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.
56 .. cpp:class:: template<class R, class... P> simgrid::xbt::signal<R(P...)>
58 A signal/slot mechanism, where you can attach callbacks to a given signal, and then fire the signal.
60 The template parameter is the function signature of the signal (the return value currently ignored).
62 .. cpp:function::: template<class R, class... P, class U> unsigned int simgrid::xbt::signal<R(P...)>::connect(U slot)
64 Add a new callback to this signal.
66 .. cpp:function:: template<class R, class... P> simgrid::xbt::signal<R(P...)>::operator()(P... args)
68 Fire that signal, invoking all callbacks.
70 Partial list of existing signals in s4u:
72 - :cpp:func:`Actor::on_creation <simgrid::s4u::Actor::on_creation_cb>`
73 :cpp:func:`Actor::on_suspend <simgrid::s4u::Actor::on_suspend_cb>`
74 :cpp:func:`Actor::on_resume <simgrid::s4u::Actor::on_resume_cb>`
75 :cpp:func:`Actor::on_sleep <simgrid::s4u::Actor::on_sleep_cb>`
76 :cpp:func:`Actor::on_wake_up <simgrid::s4u::Actor::on_wake_up_cb>`
77 :cpp:func:`Actor::on_host_change <simgrid::s4u::Actor::on_host_change_cb>`
78 :cpp:func:`Actor::on_termination <simgrid::s4u::Actor::on_termination_cb>`
79 :cpp:func:`Actor::on_destruction <simgrid::s4u::Actor::on_destruction_cb>`
80 - :cpp:func:`Comm::on_send <simgrid::s4u::Comm::on_send_cb>`
81 :cpp:func:`Comm::on_recv <simgrid::s4u::Comm::on_recv_cb>`
82 :cpp:func:`Comm::on_completion <simgrid::s4u::Comm::on_completion_cb>`
83 - :cpp:func:`CommImpl::on_start <simgrid::s4u::Comm::on_start_cb>`
84 :cpp:func:`CommImpl::on_completion <simgrid::s4u::Comm::on_completion_cb>`
85 - :cpp:func:`Disk::on_creation <simgrid::s4u::Disk::on_creation_cb>`
86 :cpp:func:`Disk::on_destruction <simgrid::s4u::Disk::on_destruction_cb>`
87 :cpp:func:`Disk::on_state_change <simgrid::s4u::Disk::on_state_change_cb>`
88 - :cpp:func:`Engine::on_platform_creation <simgrid::s4u::Engine::on_platform_creation_cb>`
89 :cpp:func:`Engine::on_platform_created <simgrid::s4u::Engine::on_platform_created_cb>`
90 :cpp:func:`Engine::on_time_advance <simgrid::s4u::Engine::on_time_advance_cb>`
91 :cpp:func:`Engine::on_simulation_end <simgrid::s4u::Engine::on_simulation_end_cb>`
92 :cpp:func:`Engine::on_deadlock <simgrid::s4u::Engine::on_deadlock_cb>`
93 - :cpp:func:`Exec::on_start <simgrid::s4u::Exec::on_start_cb>`
94 :cpp:func:`Exec::on_completion <simgrid::s4u::Exec::on_completion_cb>`
95 - :cpp:func:`Host::on_creation <simgrid::s4u::Host::on_creation_cb>`
96 :cpp:func:`Host::on_destruction <simgrid::s4u::Host::on_destruction_cb>`
97 :cpp:func:`Host::on_state_change <simgrid::s4u::Host::on_state_change_cb>`
98 :cpp:func:`Host::on_speed_change <simgrid::s4u::Host::on_speed_change_cb>`
99 - :cpp:func:`Io::on_start <simgrid::s4u::Io::on_start_cb>`
100 :cpp:func:`Io::on_completion <simgrid::s4u::Io::on_completion_cb>`
101 - :cpp:func:`Link::on_creation <simgrid::s4u::Link::on_creation_cb>`
102 :cpp:func:`Link::on_destruction <simgrid::s4u::Link::on_destruction_cb>`
103 :cpp:func:`Link::on_state_change <simgrid::s4u::Link::on_state_change_cb>`
104 :cpp:func:`Link::on_speed_change <simgrid::s4u::Link::on_bandwidth_change_cb>`
105 :cpp:func:`Link::on_communication_state_change <simgrid::s4u::Link::on_communication_state_change_cb>`
106 - :cpp:func:`NetZone::on_creation <simgrid::s4u::NetZone::on_creation_cb>`
107 :cpp:func:`NetZone::on_seal <simgrid::s4u::NetZone::on_seal_cb>`
108 - :cpp:func:`VirtualMachine::on_start <simgrid::s4u::VirtualMachine::on_start_cb>`
109 :cpp:func:`VirtualMachine::on_started <simgrid::s4u::VirtualMachine::on_started_cb>`
110 :cpp:func:`VirtualMachine::on_suspend <simgrid::s4u::VirtualMachine::on_suspend_cb>`
111 :cpp:func:`VirtualMachine::on_resume <simgrid::s4u::VirtualMachine::on_resume_cb>`
112 :cpp:func:`VirtualMachine::on_migration_start <simgrid::s4u::VirtualMachine::on_migration_start_cb>`
113 :cpp:func:`VirtualMachine::on_migration_end <simgrid::s4u::VirtualMachine::on_migration_end_cb>`
118 Only the major plugins are described here. Please check in src/plugins
119 to explore the other ones.
121 .. _plugin_host_energy:
126 .. doxygengroup:: plugin_host_energy
130 .. _plugin_link_energy:
135 .. doxygengroup:: plugin_link_energy
137 .. _plugin_link_energy_wifi:
142 .. doxygengroup:: plugin_link_energy_wifi
146 .. _plugin_host_load:
151 .. doxygengroup:: plugin_host_load
155 .. _plugin_filesystem:
160 .. doxygengroup:: plugin_filesystem
163 .. LocalWords: SimGrid