1 .. S4U (Simgrid for you) is the modern interface of SimGrid, which new project should use.
3 .. This file follows the ReStructured syntax to be included in the
4 .. documentation, but it should remain readable directly.
10 SimGrid comes with an extensive set of examples, documented on this
11 page. Most of them only demonstrate one single feature, with some
12 larger examplars listed below.
14 The C++ examples can be found under examples/cpp while python examples
15 are in examples/python. Each such directory contains the source code (also listed
16 from this page), and the so-called tesh file containing how to call
17 the binary obtained by compiling this example and also the expected
18 output. Tesh files are used to turn each of our examples into an
19 integration test. Some examples also contain other files, on need.
21 A good way to bootstrap your own project is to copy and combine some
22 of the provided examples to constitute the skeleton of what you plan
27 ===========================
28 Actors: the Active Entities
29 ===========================
31 Starting and Stopping Actors
32 ----------------------------
34 - **Creating actors:**
35 Most actors are started from the deployment XML file, because this
36 is a :ref:`better scientific habit <howto_science>`, but you can
37 also create them directly from your code.
41 .. example-tab:: examples/cpp/actor-create/s4u-actor-create.cpp
43 You create actors either:
45 - Directly with :cpp:func:`simgrid::s4u::Actor::create`
46 - From XML with :cpp:func:`simgrid::s4u::Engine::register_actor` (if your actor is a class)
47 or :cpp:func:`simgrid::s4u::Engine::register_function` (if your actor is a function)
48 and then :cpp:func:`simgrid::s4u::Engine::load_deployment`
50 .. example-tab:: examples/python/actor-create/actor-create.py
52 You create actors either:
54 - Directly with :py:func:`simgrid.Actor.create()`
55 - From XML with :py:func:`simgrid.Engine.register_actor()` and then :py:func:`simgrid.Engine.load_deployment()`
57 .. example-tab:: examples/c/actor-create/actor-create.c
59 You create actors either:
61 - Directly with :cpp:func:`sg_actor_create()` followed by :cpp:func:`sg_actor_start`.
62 - From XML with :cpp:func:`simgrid_register_function` and then :cpp:func:`simgrid_load_deployment`.
64 .. example-tab:: examples/python/actor-create/actor-create_d.xml
66 The following file is used in both C++ and Python.
68 - **React to the end of actors:** You can attach callbacks to the end of
69 actors. There is several ways of doing so, depending on whether you want to
70 attach your callback to a given actor and on how you define the end of a
71 given actor. User code probably want to react to the termination of an actor
72 while some plugins want to react to the destruction (memory collection) of
77 .. example-tab:: examples/cpp/actor-exiting/s4u-actor-exiting.cpp
79 This example shows how to attach a callback to:
81 - the end of a specific actor: :cpp:func:`simgrid::s4u::Actor::on_exit()`
82 - the end of any actor: :cpp:member:`simgrid::s4u::Actor::on_termination()`
83 - the destruction of any actor: :cpp:member:`simgrid::s4u::Actor::on_destruction()`
85 .. example-tab:: examples/c/actor-exiting/actor-exiting.c
87 This example shows how to attach a callback to the end of a specific actor with
88 :cpp:func:`sg_actor_on_exit()`.
91 Actors can forcefully stop other actors.
95 .. example-tab:: examples/cpp/actor-kill/s4u-actor-kill.cpp
97 See also :cpp:func:`void simgrid::s4u::Actor::kill(void)`, :cpp:func:`void simgrid::s4u::Actor::kill_all()`,
98 :cpp:func:`simgrid::s4u::this_actor::exit`, :cpp:func:`simgrid::s4u::Actor::on_exit`.
100 .. example-tab:: examples/python/actor-kill/actor-kill.py
102 See also :py:func:`simgrid.Actor.kill`, :py:func:`simgrid.Actor.kill_all`, :py:func:`simgrid.this_actor.exit`,
103 :py:func:`simgrid.this_actor.on_exit`.
105 .. example-tab:: examples/c/actor-kill/actor-kill.c
107 See also :cpp:func:`sg_actor_kill`, :cpp:func:`sg_actor_kill_all`, :cpp:func:`sg_actor_exit`, :cpp:func:`sg_actor_on_exit`.
109 - **Controlling the actor life cycle from the XML:**
110 You can specify a start time and a kill time in the deployment file.
114 .. example-tab:: examples/cpp/actor-lifetime/s4u-actor-lifetime.cpp
116 This file is not really interesting: the important matter is in the XML file.
118 .. example-tab:: examples/cpp/actor-lifetime/s4u-actor-lifetime_d.xml
120 This demonstrates the ``start_time`` and ``kill_time`` attribute of the :ref:`pf_tag_actor` tag.
122 .. example-tab:: examples/python/actor-lifetime/actor-lifetime.py
124 This file is not really interesting: the important matter is in the XML file.
126 .. example-tab:: examples/c/actor-lifetime/actor-lifetime.c
128 This file is not really interesting: the important matter is in the XML file.
130 - **Daemonize actors:**
131 Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
132 actor into a daemon that will be automatically killed once the simulation is over.
136 .. example-tab:: examples/cpp/actor-daemon/s4u-actor-daemon.cpp
138 See also :cpp:func:`simgrid::s4u::Actor::daemonize()` and :cpp:func:`simgrid::s4u::Actor::is_daemon()`.
140 .. example-tab:: examples/python/actor-daemon/actor-daemon.py
142 See also :py:func:`simgrid.Actor.daemonize()` and :py:func:`simgrid.Actor.is_daemon()`.
144 .. example-tab:: examples/c/actor-daemon/actor-daemon.c
146 See also :cpp:func:`sg_actor_daemonize` and :cpp:func:`sg_actor_is_daemon`.
148 - **Specify the stack size to use**
149 The stack size can be specified by default on the command line,
150 globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config`,
151 or for a specific actor using :cpp:func:`simgrid::s4u::Actor::set_stacksize` before its start.
155 .. example-tab:: examples/cpp/actor-stacksize/s4u-actor-stacksize.cpp
157 .. example-tab:: examples/c/actor-stacksize/actor-stacksize.c
159 Inter-Actors Interactions
160 -------------------------
162 See also the examples on :ref:`inter-actors communications
163 <s4u_ex_communication>` and the ones on :ref:`classical
164 synchronization objects <s4u_ex_IPC>`.
166 - **Suspend and Resume actors:**
167 Actors can be suspended and resumed during their executions.
171 .. example-tab:: examples/cpp/actor-suspend/s4u-actor-suspend.cpp
173 See also :cpp:func:`simgrid::s4u::this_actor::suspend()`,
174 :cpp:func:`simgrid::s4u::Actor::suspend()`, :cpp:func:`simgrid::s4u::Actor::resume()`, and
175 :cpp:func:`simgrid::s4u::Actor::is_suspended()`.
177 .. example-tab:: examples/python/actor-suspend/actor-suspend.py
179 See also :py:func:`simgrid.this_actor.suspend()`,
180 :py:func:`simgrid.Actor.suspend()`, :py:func:`simgrid.Actor.resume()`, and
181 :py:func:`simgrid.Actor.is_suspended()`.
183 .. example-tab:: examples/c/actor-suspend/actor-suspend.c
185 See also :cpp:func:`sg_actor_suspend()`, :cpp:func:`sg_actor_resume()`, and
186 :cpp:func:`sg_actor_is_suspended()`.
188 - **Migrating Actors:**
189 Actors can move or be moved from a host to another very easily. It amount to setting them on a new host.
193 .. example-tab:: examples/cpp/actor-migrate/s4u-actor-migrate.cpp
195 See also :cpp:func:`simgrid::s4u::this_actor::set_host()` and :cpp:func:`simgrid::s4u::Actor::set_host()`.
197 .. example-tab:: examples/python/actor-migrate/actor-migrate.py
199 See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.set_host()`.
201 .. example-tab:: examples/c/actor-migrate/actor-migrate.c
203 See also :cpp:func:`sg_actor_set_host()`.
205 - **Waiting for the termination of an actor:** (joining on it)
206 You can block the current actor until the end of another actor.
210 .. example-tab:: examples/cpp/actor-join/s4u-actor-join.cpp
212 See also :cpp:func:`simgrid::s4u::Actor::join()`.
214 .. example-tab:: examples/python/actor-join/actor-join.py
216 See also :py:func:`simgrid.Actor.join()`.
218 .. example-tab:: examples/c/actor-join/actor-join.c
220 See also :cpp:func:`sg_actor_join`.
222 - **Yielding to other actors**.
223 The ```yield()``` function interrupts the execution of the current
224 actor, leaving a chance to the other actors that are ready to run
229 .. example-tab:: examples/cpp/actor-yield/s4u-actor-yield.cpp
231 See also :cpp:func:`simgrid::s4u::this_actor::yield()`.
233 .. example-tab:: examples/python/actor-yield/actor-yield.py
235 See also :py:func:`simgrid.this_actor.yield_()`.
237 .. example-tab:: examples/c/actor-yield/actor-yield.c
239 See also :cpp:func:`sg_actor_yield()`.
241 Traces Replay as a Workload
242 ---------------------------
244 This section details how to run trace-driven simulations. It is very
245 handy when you want to test an algorithm or protocol that only react
246 to external events. For example, many P2P protocols react to user
247 requests, but do nothing if there is no such event.
249 In such situations, you should write your protocol in C++, and separate
250 the workload that you want to play onto your protocol in a separate
251 text file. Declare a function handling each type of the events in your
252 trace, register them using :cpp:func:`xbt_replay_action_register()` in
253 your main, and then run the simulation.
255 Then, you can either have one trace file containing all your events,
256 or a file per simulated process: the former may be easier to work
257 with, but the second is more efficient on very large traces. Check
258 also the tesh files in the example directories for details.
260 - **Communication replay:**
261 Presents a set of event handlers reproducing classical communication
262 primitives (asynchronous send/receive at the moment).
266 .. example-tab:: examples/cpp/replay-comm/s4u-replay-comm.cpp
269 Presents a set of event handlers reproducing classical I/O
270 primitives (open, read, close).
274 .. example-tab:: examples/cpp/replay-io/s4u-replay-io.cpp
276 ==========================
277 Activities: what Actors do
278 ==========================
280 .. _s4u_ex_communication:
282 Communications on the Network
283 -----------------------------
285 - **Basic communications:**
286 This simple example just sends one message back and forth.
287 The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
288 the simulators (as detailed in Section :ref:`options`).
292 .. example-tab:: examples/cpp/comm-pingpong/s4u-comm-pingpong.cpp
294 .. example-tab:: examples/c/comm-pingpong/comm-pingpong.c
297 - **Basic asynchronous communications:**
298 Illustrates how to have non-blocking communications, that are
299 communications running in the background leaving the process free
300 to do something else during their completion.
304 .. example-tab:: examples/cpp/comm-wait/s4u-comm-wait.cpp
306 See also :cpp:func:`simgrid::s4u::Mailbox::put_async()` and :cpp:func:`simgrid::s4u::Comm::wait()`.
308 .. example-tab:: examples/python/comm-wait/comm-wait.py
310 See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`.
312 .. example-tab:: examples/c/comm-wait/comm-wait.c
314 See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm__wait()`.
316 - **Waiting communications with timeouts:**
317 This example is very similar to the previous one, simply adding how to declare timeouts when waiting on asynchronous communication.
321 .. example-tab:: examples/cpp/comm-waituntil/s4u-comm-waituntil.cpp
323 See also :cpp:func:`simgrid::s4u::Mailbox::wait_until()` and :cpp:func:`simgrid::s4u::Comm::wait_for()`.
325 - **Suspending communications:**
326 The ``suspend()`` and ``resume()`` functions allow to block the
327 progression of a given communication for a while and then unblock it.
328 ``is_suspended()`` can be used to retrieve whether the activity is
329 currently blocked or not.
333 .. example-tab:: examples/cpp/comm-suspend/s4u-comm-suspend.cpp
335 See also :cpp:func:`simgrid::s4u::Activity::suspend()`
336 :cpp:func:`simgrid::s4u::Activity::resume()` and
337 :cpp:func:`simgrid::s4u::Activity::is_suspended()`.
340 - **Waiting for all communications in a set:**
341 The ``wait_all()`` function is useful when you want to block until
342 all activities in a given set have completed.
346 .. example-tab:: examples/cpp/comm-waitall/s4u-comm-waitall.cpp
348 See also :cpp:func:`simgrid::s4u::Comm::wait_all()`.
350 .. example-tab:: examples/python/comm-waitall/comm-waitall.py
352 See also :py:func:`simgrid.Comm.wait_all()`.
354 .. example-tab:: examples/c/comm-waitall/comm-waitall.c
356 See also :cpp:func:`sg_comm_wait_all()`.
358 - **Waiting for the first completed communication in a set:**
359 The ``wait_any()`` function is useful
360 when you want to block until one activity of the set completes, no
361 matter which terminates first.
365 .. example-tab:: examples/cpp/comm-waitany/s4u-comm-waitany.cpp
367 See also :cpp:func:`simgrid::s4u::Comm::wait_any()`.
369 .. example-tab:: examples/python/comm-waitany/comm-waitany.py
371 See also :py:func:`simgrid.Comm.wait_any()`.
373 .. example-tab:: examples/c/comm-waitany/comm-waitany.c
375 See also :cpp:func:`sg_comm_wait_any`.
377 .. _s4u_ex_execution:
379 Executions on the CPU
380 ---------------------
382 - **Basic execution:**
383 The computations done in your program are not reported to the
384 simulated world, unless you explicitly request the simulator to pause
385 the actor until a given amount of flops gets computed on its simulated
386 host. Some executions can be given an higher priority so that they
391 .. example-tab:: examples/cpp/exec-basic/s4u-exec-basic.cpp
393 See also :cpp:func:`void simgrid::s4u::this_actor::execute(double)`
394 and :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`.
396 .. example-tab:: examples/python/exec-basic/exec-basic.py
398 See also :py:func:`simgrid.this_actor.execute()`.
400 .. example-tab:: examples/c/exec-basic/exec-basic.c
402 See also :cpp:func:`void sg_actor_execute(double)`
403 and :cpp:func:`void sg_actor_execute_with_priority(double, double)`.
405 - **Asynchronous execution:**
406 You can start asynchronous executions, just like you would fire
411 .. example-tab:: examples/cpp/exec-async/s4u-exec-async.cpp
413 See also :cpp:func:`simgrid::s4u::this_actor::exec_init()`,
414 :cpp:func:`simgrid::s4u::Activity::start()`,
415 :cpp:func:`simgrid::s4u::Activity::wait()`,
416 :cpp:func:`simgrid::s4u::Activity::get_remaining()`,
417 :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`,
418 :cpp:func:`simgrid::s4u::this_actor::exec_async()` and
419 :cpp:func:`simgrid::s4u::Activity::cancel()`.
421 .. example-tab:: examples/python/exec-async/exec-async.py
423 See also :py:func:`simgrid.this_actor::exec_init()`,
424 :py:func:`simgrid.Activity::start()`,
425 :py:func:`simgrid.Activity.wait()`,
426 :py:func:`simgrid.Activity.get_remaining()`,
427 :py:func:`simgrid.Exec.get_remaining_ratio()`,
428 :py:func:`simgrid.this_actor.exec_async()` and
429 :py:func:`simgrid.Activity.cancel()`.
431 .. example-tab:: examples/c/exec-async/exec-async.c
433 See also :cpp:func:`sg_actor_exec_init()`,
434 :cpp:func:`sg_exec_start()`,
435 :cpp:func:`sg_exec_wait()`,
436 :cpp:func:`sg_exec_get_remaining()`,
437 :cpp:func:`sg_exec_get_remaining_ratio()`,
438 :cpp:func:`sg_actor_exec_async()` and
439 :cpp:func:`sg_exec_cancel()`,
441 - **Remote execution:**
442 You can start executions on remote hosts, or even change the host
443 on which they occur during their execution.
447 .. example-tab:: examples/cpp/exec-remote/s4u-exec-remote.cpp
449 See also :cpp:func:`simgrid::s4u::Exec::set_host()`.
451 .. example-tab:: examples/python/exec-remote/exec-remote.py
453 See also :py:func:`simgrid.Exec.set_host()`.
455 .. example-tab:: examples/c/exec-remote/exec-remote.c
457 See also :cpp:func:`sg_exec_set_host()`.
459 - **Parallel executions:**
460 These objects are convenient abstractions of parallel
461 computational kernels that span over several machines, such as a
462 PDGEM and the other ScaLAPACK routines. Note that this only works
463 with the "ptask_L07" host model (``--cfg=host/model:ptask_L07``).
465 This example demonstrates several kind of parallel tasks: regular
466 ones, communication-only (without computation), computation-only
467 (without communication), synchronization-only (neither
468 communication nor computation). It also shows how to reconfigure a
469 task after its start, to change the amount of hosts it runs onto.
470 This allows to simulate malleable tasks.
474 .. example-tab:: examples/cpp/exec-ptask/s4u-exec-ptask.cpp
476 See also :cpp:func:`simgrid::s4u::this_actor::parallel_execute()`.
478 - **Using Pstates on a host:**
479 This example shows how define a set of pstates in the XML. The current pstate
480 of a host can then be accessed and changed from the program.
484 .. example-tab:: examples/cpp/exec-dvfs/s4u-exec-dvfs.cpp
486 See also :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`.
488 .. example-tab:: examples/c/exec-dvfs/exec-dvfs.c
490 See also :cpp:func:`sg_host_get_pstate_speed` and :cpp:func:`sg_host_set_pstate`.
492 .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py
494 See also :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`.
496 .. example-tab:: examples/platforms/energy_platform.xml
500 I/O on Disks and Files
501 ----------------------
503 SimGrid provides two levels of abstraction to interact with the
504 simulated disks. At the simplest level, you simply create read and
505 write actions on the disk resources.
507 - **Access to raw disk devices:**
508 This example illustrates how to simply read and write data on a
509 simulated disk resource.
513 .. example-tab:: examples/cpp/io-disk-raw/s4u-io-disk-raw.cpp
515 .. example-tab:: examples/c/io-disk-raw/io-disk-raw.c
517 .. example-tab:: examples/platforms/hosts_with_disks.xml
519 This shows how to declare disks in XML.
521 The FileSystem plugin provides a more detailed view, with the
522 classical operations over files: open, move, unlink, and of course
523 read and write. The file and disk sizes are also dealt with and can
524 result in short reads and short write, as in reality.
526 - **File Management:**
527 This example illustrates the use of operations on files
528 (read, write, seek, tell, unlink, etc).
532 .. example-tab:: examples/cpp/io-file-system/s4u-io-file-system.cpp
535 I/O operations on files can also be done in a remote fashion,
536 i.e. when the accessed disk is not mounted on the caller's host.
540 .. example-tab:: examples/cpp/io-file-remote/s4u-io-file-remote.cpp
542 .. example-tab:: examples/c/io-file-remote/io-file-remote.c
546 Classical synchronization objects
547 ---------------------------------
550 Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
554 .. example-tab:: examples/cpp/synchro-barrier/s4u-synchro-barrier.cpp
556 - **Condition variable: basic usage**
557 Shows how to use :cpp:type:`simgrid::s4u::ConditionVariable` synchronization objects.
561 .. example-tab:: examples/cpp/synchro-condition-variable/s4u-synchro-condition-variable.cpp
563 - **Condition variable: timeouts**
564 Shows how to specify timeouts when blocking on condition variables.
568 .. example-tab:: examples/cpp/synchro-condition-variable-waituntil/s4u-synchro-condition-variable-waituntil.cpp
571 Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
575 .. example-tab:: examples/cpp/synchro-mutex/s4u-synchro-mutex.cpp
578 Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
582 .. example-tab:: examples/cpp/synchro-semaphore/s4u-synchro-semaphore.cpp
584 .. example-tab:: examples/c/synchro-semaphore/synchro-semaphore.c
586 =============================
587 Interacting with the Platform
588 =============================
590 - **User-defined properties:**
591 You can attach arbitrary information to most platform elements from
592 the XML file, and then interact with these values from your
593 program. Note that the changes are not written permanently on disk,
594 in the XML file nor anywhere else. They only last until the end of
599 .. example-tab:: examples/cpp/platform-properties/s4u-platform-properties.cpp
601 - :cpp:func:`simgrid::s4u::Actor::get_property()` and :cpp:func:`simgrid::s4u::Actor::set_property()`
602 - :cpp:func:`simgrid::s4u::Host::get_property()` and :cpp:func:`simgrid::s4u::Host::set_property()`
603 - :cpp:func:`simgrid::s4u::Link::get_property()` and :cpp:func:`simgrid::s4u::Link::set_property()`
604 - :cpp:func:`simgrid::s4u::NetZone::get_property()` and :cpp:func:`simgrid::s4u::NetZone::set_property()`
606 .. example-tab:: examples/c/platform-properties/platform-properties.c
608 - :cpp:func:`sg_actor_get_property()` and :cpp:func:`sg_actor_set_property()`
609 - :cpp:func:`sg_host_get_property()` and :cpp:func:sg_host_set_property()`
610 - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()`
611 - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()`
617 .. showfile:: examples/cpp/platform-properties/s4u-platform-properties_d.xml
623 .. showfile:: examples/platforms/prop.xml
626 - **Retrieving the netzones matching a given criteria:**
627 Shows how to filter the cluster netzones.
631 .. example-tab:: examples/cpp/routing-get-clusters/s4u-routing-get-clusters.cpp
633 - **Retrieving the list of hosts matching a given criteria:**
634 Shows how to filter the actors that match a given criteria.
638 .. example-tab:: examples/cpp/engine-filtering/s4u-engine-filtering.cpp
640 - **Specifying state profiles:** shows how to specify when the
641 resources must be turned off and on again, and how to react to such
642 failures in your code. See also :ref:`howto_churn`.
646 .. example-tab:: examples/cpp/platform-failures/s4u-platform-failures.cpp
648 .. example-tab:: examples/c/platform-failures/platform-failures.c
652 .. showfile:: examples/platforms/small_platform_failures.xml
655 .. showfile:: examples/platforms/profiles/jupiter_state.profile
657 .. showfile:: examples/platforms/profiles/bourassa_state.profile
659 .. showfile:: examples/platforms/profiles/fafard_state.profile
661 - **Specifying speed profiles:** shows how to specify an external
662 load to resources, variating their peak speed over time.
666 .. example-tab:: examples/cpp/platform-profile/s4u-platform-profile.cpp
670 .. showfile:: examples/platforms/small_platform_profile.xml
673 .. showfile:: examples/platforms/profiles/jupiter_speed.profile
675 .. showfile:: examples/platforms/profiles/link1_bandwidth.profile
677 .. showfile:: examples/platforms/profiles/link1_latency.profile
683 - **Describing the energy profiles in the platform:**
684 The first platform file contains the energy profile of each links and
685 hosts for a wired network, which is necessary to get energy consumption
686 predictions. The second platform file is the equivalent for a wireless
687 network. As usual, you should not trust our example, and you should
688 strive to double-check that your instantiation matches your target
695 .. showfile:: examples/platforms/energy_platform.xml
698 .. showfile:: examples/platforms/wifi_energy.xml
701 - **Consumption due to the CPU:**
702 This example shows how to retrieve the amount of energy consumed
703 by the CPU during computations, and the impact of the pstate.
707 .. example-tab:: examples/cpp/energy-exec/s4u-energy-exec.cpp
709 .. example-tab:: examples/c/energy-exec/energy-exec.c
711 - **Consumption due to the wired network:**
712 This example shows how to retrieve and display the energy consumed
713 by the wired network during communications.
717 .. example-tab:: examples/cpp/energy-link/s4u-energy-link.cpp
719 - **Consumption due to the wireless network:**
720 This example shows how to retrieve and display the energy consumed
721 by the wireless network during communications.
725 .. example-tab:: examples/cpp/energy-wifi/s4u-energy-wifi.cpp
727 - **Modeling the shutdown and boot of hosts:**
728 Simple example of model of model for the energy consumption during
729 the host boot and shutdown periods.
733 .. example-tab:: examples/cpp/energy-boot/platform_boot.xml
735 .. example-tab:: examples/cpp/energy-boot/s4u-energy-boot.cpp
737 =======================
738 Tracing and Visualizing
739 =======================
741 Tracing can be activated by various configuration options which
742 are illustrated in these example. See also the
743 :ref:`full list of options related to tracing <tracing_tracing_options>`.
745 It is interesting to run the process-create example with the following
746 options to see the task executions:
748 - **Platform Tracing:**
749 This program is a toy example just loading the platform, so that
750 you can play with the platform visualization. Recommended options:
751 ``--cfg=tracing:yes --cfg=tracing/categorized:yes``
755 .. example-tab:: examples/cpp/trace-platform/s4u-trace-platform.cpp
757 - **Setting Categories**
758 This example declares several tracing categories to that are used to
759 classify its tasks. When the program is executed, the tracing mechanism
760 registers the resource utilization of hosts and links according to these
761 categories. Recommended options:
762 ``--cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes``
766 .. example-tab:: examples/cpp/trace-categories/s4u-trace-categories.cpp
768 - **Master Workers tracing**
769 This is an augmented version of our basic master/worker example using
770 several tracing features. It traces resource usage, sorted out in several
771 categories; Trace marks and user variables are also used. Recommended
772 options: ``--cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes``
776 .. example-tab:: examples/cpp/trace-masterworkers/s4u-trace-masterworkers.cpp
778 - **Process migration tracing**
779 This version is enhanced so that the process migrations can be displayed
780 as arrows in a Gantt-chart visualization. Recommended options to that
781 extend: ``--cfg=tracing:yes --cfg=tracing/actor:yes``
785 .. example-tab:: examples/cpp/trace-process-migration/s4u-trace-process-migration.cpp
788 TODO: These tracing examples should be integrated in the examples to not
789 duplicate the C++ files. A full command line to see the result in the right
790 tool (vite/FrameSoc) should be given along with some screenshots.
792 Tracing user variables
793 ----------------------
795 You can also attach your own variables to any resource described in the platform
796 file. The following examples illustrate this feature. They have to be run with
797 the following options: ``--cfg=tracing:yes --cfg=tracing/platform:yes``
799 - **Attaching variables to Hosts**
803 .. example-tab:: examples/cpp/trace-host-user-variables/s4u-trace-host-user-variables.cpp
805 - **Attaching variables to Links**
806 The tricky part is that you have to know the name of the link you want to
807 enhance with a variable.
811 .. example-tab:: examples/cpp/trace-link-user-variables/s4u-trace-link-user-variables.cpp
813 - **Attaching variables to network Routes**
814 It is often easier to update a given variable for all links of a given
815 network path (identified by its source and destination hosts) instead of
816 knowing the name of each specific link.
820 .. example-tab:: examples/cpp/trace-route-user-variables/s4u-trace-route-user-variables.cpp
822 ========================
823 Larger SimGrid Examplars
824 ========================
826 This section contains application examples that are somewhat larger
827 than the previous examples.
830 Shows how to implement a classical communication pattern, where a
831 token is exchanged along a ring to reach every participant.
835 .. example-tab:: examples/cpp/app-token-ring/s4u-app-token-ring.cpp
837 .. example-tab:: examples/c/app-token-ring/app-token-ring.c
839 - **Master Workers:**
840 Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
847 This example comes in two equivalent variants, one where the actors
848 are specified as simple functions (which is easier to understand for
849 newcomers) and one where the actors are specified as classes (which is
850 more powerful for the users wanting to build their own projects upon
853 .. showfile:: examples/cpp/app-masterworkers/s4u-app-masterworkers-class.cpp
856 .. showfile:: examples/cpp/app-masterworkers/s4u-app-masterworkers-fun.cpp
861 .. showfile:: examples/c/app-masterworker/app-masterworker.c
868 Classical protocol for Peer-to-Peer data diffusion.
874 .. showfile:: examples/cpp/app-bittorrent/s4u-bittorrent.cpp
877 .. showfile:: examples/cpp/app-bittorrent/s4u-peer.cpp
880 .. showfile:: examples/cpp/app-bittorrent/s4u-tracker.cpp
885 .. showfile:: examples/c/app-bittorrent/app-bittorrent.c
888 .. showfile:: examples/c/app-bittorrent/bittorrent-peer.c
891 .. showfile:: examples/c/app-bittorrent/tracker.c
895 Data broadcast over a ring of processes.
899 .. example-tab:: examples/cpp/app-chainsend/s4u-app-chainsend.cpp
903 .. showfile:: examples/c/app-chainsend/chainsend.c
906 .. showfile:: examples/c/app-chainsend/broadcaster.c
909 .. showfile:: examples/c/app-chainsend/peer.c
912 Distributed Hash Tables (DHT)
913 -----------------------------
916 One of the most famous DHT protocol.
922 .. showfile:: examples/cpp/dht-chord/s4u-dht-chord.cpp
925 .. showfile:: examples/cpp/dht-chord/s4u-dht-chord-node.cpp
929 Another well-known DHT protocol.
935 .. showfile:: examples/cpp/dht-kademlia/s4u-dht-kademlia.cpp
938 .. showfile:: examples/cpp/dht-kademlia/routing_table.cpp
941 .. showfile:: examples/cpp/dht-kademlia/answer.cpp
944 .. showfile:: examples/cpp/dht-kademlia/node.cpp
949 .. showfile:: examples/c/dht-kademlia/dht-kademlia.c
952 .. showfile:: examples/c/dht-kademlia/routing_table.c
955 .. showfile:: examples/c/dht-kademlia/answer.c
958 .. showfile:: examples/c/dht-kademlia/message.c
961 .. showfile:: examples/c/dht-kademlia/node.c
970 This example starts some computations both on PMs and VMs, and
971 migrates some VMs around.
975 .. example-tab:: examples/cpp/cloud-simple/s4u-cloud-simple.cpp
977 .. example-tab:: examples/c/cloud-simple/cloud-simple.c
980 This example shows how to migrate VMs between PMs.
984 .. example-tab:: examples/cpp/cloud-migration/s4u-cloud-migration.cpp
986 .. example-tab:: examples/c/cloud-migration/cloud-migration.c
988 =======================
989 Model-Related Examples
990 =======================
992 - **ns-3 as a SimGrid Network Model**
993 This simple ping-pong example demonstrates how to use the bindings to the Network
994 Simulator. The most interesting is probably not the C++ files since
995 they are unchanged from the other simulations, but the associated files,
996 such as the platform file to see how to declare a platform to be used
997 with the ns-3 bindings of SimGrid and the tesh file to see how to actually
998 start a simulation in these settings.
1002 .. example-tab:: examples/cpp/network-ns3/s4u-network-ns3.cpp
1008 .. showfile:: examples/platforms/small_platform_one_link_routes.xml
1013 This demonstrates how to declare a wifi link in your platform and
1014 how to use it in your simulation. The basics is to have a link
1015 which sharing policy is set to `WIFI`. Such links can have more
1016 than one bandwidth value (separated by commas), corresponding to
1017 the several SNR level of your wifi link.
1019 In this case, SimGrid automatically switches to validated
1020 performance models of wifi networks, where the time is shared
1021 between users instead of the bandwidth for wired links (the
1022 corresponding publication is currently being written).
1024 If your wifi link provides more than one SNR level, you can switch
1025 the level of a given host using
1026 :cpp:func:`simgrid::s4u::Link::set_host_wifi_rate`. By default,
1027 the first level is used.
1031 .. example-tab:: examples/cpp/network-wifi/s4u-network-wifi.cpp
1037 .. showfile:: examples/platforms/wifi.xml
1044 It is possible to extend SimGrid without modifying its internals by
1045 attaching code to the existing signals and by adding extra data to the
1046 simulation objects through extensions. How to do that is not exactly
1047 documented yet, and you should look for examples in the src/plugins
1050 This section documents how the existing plugins can be used. Remember
1051 that you are very welcome to modify the plugins to fit your needs. It
1052 should be much easier than modifying the SimGrid kernel.
1054 - **Monitoring the host load**
1058 .. example-tab:: examples/cpp/plugin-host-load/s4u-plugin-host-load.cpp
1060 .. example-tab:: examples/c/plugin-host-load/plugin-host-load.c
1062 - **Monitoring the link load**
1066 .. example-tab:: examples/cpp/plugin-link-load/s4u-plugin-link-load.cpp
1068 =======================
1069 Model-Checking Examples
1070 =======================
1072 The model-checker can be used to exhaustively search for issues in the
1073 tested application. It must be activated at compile time, but this
1074 mode is rather experimental in SimGrid (as of v3.22). You should not
1075 enable it unless you really want to formally verify your applications:
1076 SimGrid is slower and maybe less robust when MC is enabled.
1078 - **Failing assert**
1079 In this example, two actors send some data to a central server,
1080 which asserts that the messages are always received in the same order.
1081 This is obviously wrong, and the model-checker correctly finds a
1082 counter-example to that assertion.
1086 .. example-tab:: examples/cpp/mc-failing-assert/s4u-mc-failing-assert.cpp
1092 .. |cpp| image:: /img/lang_cpp.png
1096 .. |py| image:: /img/lang_python.png