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 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.
26 You can activate these plugins with the :ref:`--cfg=plugin <cfg=plugin>` command
27 line option, for example with ``--cfg=plugin:host_energy``. You can get the full
28 list of existing plugins with ``--cfg=plugin:help``.
33 A plugin can get some additional code executed within the SimGrid
34 kernel, and attach the data needed by that code to the SimGrid
37 The host load plugin in
38 `src/plugins/host_load.cpp <https://framagit.org/simgrid/simgrid/tree/master/src/plugins/host_load.cpp>`_
39 constitutes a good introductory example. It defines a class
40 ```HostLoad``` that is meant to be attached to each host. This class
41 contains a ```EXTENSION_ID``` field that is mandatory to our extension
42 mechanism. Then, the function ```sg_host_load_plugin_init```
43 initializes the plugin. It first calls
44 :cpp:func:`simgrid::s4u::Host::extension_create()` to register its
45 extension to the ```s4u::Host``` objects, and then attaches some
48 You can attach your own extension to most kinds of s4u object:
49 :cpp:class:`Actors <simgrid::s4u::Actor>`,
50 :cpp:class:`Disks <simgrid::s4u::Disk>`,
51 :cpp:class:`Hosts <simgrid::s4u::Host>` and
52 :cpp:class:`Links <simgrid::s4u::Link>`. If you need to extend another
53 kind of objects, please let us now.
55 Partial list of existing signals in s4u:
57 - :cpp:member:`Actor::on_creation <simgrid::s4u::Actor::on_creation>`
58 :cpp:member:`Actor::on_suspend <simgrid::s4u::Actor::on_suspend>`
59 :cpp:member:`Actor::on_resume <simgrid::s4u::Actor::on_resume>`
60 :cpp:member:`Actor::on_sleep <simgrid::s4u::Actor::on_sleep>`
61 :cpp:member:`Actor::on_wake_up <simgrid::s4u::Actor::on_wake_up>`
62 :cpp:member:`Actor::on_migration_start <simgrid::s4u::Actor::on_migration_start>`
63 :cpp:member:`Actor::on_migration_end <simgrid::s4u::Actor::on_migration_end>`
64 :cpp:member:`Actor::on_termination <simgrid::s4u::Actor::on_termination>`
65 :cpp:member:`Actor::on_destruction <simgrid::s4u::Actor::on_destruction>`
66 - :cpp:member:`Comm::on_sender_start <simgrid::s4u::Comm::on_sender_start>`
67 :cpp:member:`Comm::on_receiver_start <simgrid::s4u::Comm::on_receiver_start>`
68 :cpp:member:`Comm::on_completion <simgrid::s4u::Comm::on_completion>`
69 - :cpp:member:`Engine::on_platform_creation <simgrid::s4u::Engine::on_platform_creation>`
70 :cpp:member:`Engine::on_platform_created <simgrid::s4u::Engine::on_platform_created>`
71 :cpp:member:`Engine::on_time_advance <simgrid::s4u::Engine::on_time_advance>`
72 :cpp:member:`Engine::on_simulation_end <simgrid::s4u::Engine::on_simulation_end>`
73 :cpp:member:`Engine::on_deadlock <simgrid::s4u::Engine::on_deadlock>`
74 - :cpp:member:`Exec::on_start <simgrid::s4u::Exec::on_start>`
75 :cpp:member:`Exec::on_completion <simgrid::s4u::Exec::on_completion>`
76 - :cpp:member:`Host::on_creation <simgrid::s4u::Host::on_creation>`
77 :cpp:member:`Host::on_destruction <simgrid::s4u::Host::on_destruction>`
78 :cpp:member:`Host::on_state_change <simgrid::s4u::Host::on_state_change>`
79 :cpp:member:`Host::on_speed_change <simgrid::s4u::Host::on_speed_change>`
80 - :cpp:member:`Link::on_creation <simgrid::s4u::Link::on_creation>`
81 :cpp:member:`Link::on_destruction <simgrid::s4u::Link::on_destruction>`
82 :cpp:member:`Link::on_state_change <simgrid::s4u::Link::on_state_change>`
83 :cpp:member:`Link::on_speed_change <simgrid::s4u::Link::on_bandwidth_change>`
84 :cpp:member:`Link::on_communicate <simgrid::s4u::Link::on_communicate>`
85 :cpp:member:`Link::on_communication_state_change <simgrid::s4u::Link::on_communication_state_change>`
86 - :cpp:member:`Netzone::on_creation <simgrid::s4u::Netzone::on_creation>`
87 :cpp:member:`Netzone::on_seal <simgrid::s4u::Netzone::on_seal>`
88 :cpp:member:`Netzone::on_route_creation <simgrid::s4u::Netzone::on_route_creation>`
89 - :cpp:member:`VirtualMachine::on_start <simgrid::s4u::VirtualMachine::on_start>`
90 :cpp:member:`VirtualMachine::on_started <simgrid::s4u::VirtualMachine::on_started>`
91 :cpp:member:`VirtualMachine::on_suspend <simgrid::s4u::VirtualMachine::on_suspend>`
92 :cpp:member:`VirtualMachine::on_resume <simgrid::s4u::VirtualMachine::on_resume>`
93 :cpp:member:`VirtualMachine::on_migration_start <simgrid::s4u::VirtualMachine::on_migration_start>`
94 :cpp:member:`VirtualMachine::on_migration_end <simgrid::s4u::VirtualMachine::on_migration_end>`
99 Only the major plugins are described here. Please check in src/plugins
100 to explore the other ones.
102 .. _plugin_host_energy:
107 .. doxygengroup:: plugin_host_energy
111 .. _plugin_link_energy:
116 .. doxygengroup:: plugin_link_energy
120 .. _plugin_host_load:
125 .. doxygengroup:: plugin_host_load
129 .. _plugin_filesystem:
134 .. doxygengroup:: plugin_filesystem
137 .. LocalWords: SimGrid