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/s4u 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 Stoping Actors
32 ---------------------------
34 - **Creating actors:**
35 Most actors are started from the deployment XML file, because this
36 is a :ref:`better scientific habbit <howto_science>`, but you can
37 also create them directly from your code.
41 .. example-tab:: examples/s4u/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/s4u/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::this_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/s4u/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::this_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 - **Controling 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/s4u/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/s4u/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/c/actor-lifetime/actor-lifetime.c
124 This file is not really interesting: the important matter is in the XML file.
126 - **Daemonize actors:**
127 Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
128 actor into a daemon that will be automatically killed once the simulation is over.
132 .. example-tab:: examples/s4u/actor-daemon/s4u-actor-daemon.cpp
134 See also :cpp:func:`simgrid::s4u::Actor::daemonize()` and :cpp:func:`simgrid::s4u::Actor::is_daemon()`.
136 .. example-tab:: examples/python/actor-daemon/actor-daemon.py
138 See also :py:func:`simgrid.Actor.daemonize()` and :py:func:`simgrid.Actor.is_daemon()`.
140 .. example-tab:: examples/c/actor-daemon/actor-daemon.c
142 See also :cpp:func:`sg_actor_daemonize` and :cpp:func:`sg_actor_is_daemon`.
144 - **Specify the stack size to use**
145 The stack size can be specified by default on the command line,
146 globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config(std::string)`,
147 or for a specific actor using :cpp:func:`simgrid::s4u::Actor::set_stacksize` before its start.
151 .. example-tab:: examples/s4u/actor-stacksize/s4u-actor-stacksize.cpp
153 .. example-tab:: examples/c/actor-stacksize/actor-stacksize.c
155 Inter-Actors Interactions
156 -------------------------
158 See also the examples on :ref:`inter-actors communications
159 <s4u_ex_communication>` and the ones on :ref:`classical
160 synchronization objects <s4u_ex_IPC>`.
162 - **Suspend and Resume actors:**
163 Actors can be suspended and resumed during their executions.
167 .. example-tab:: examples/s4u/actor-suspend/s4u-actor-suspend.cpp
169 See also :cpp:func:`simgrid::s4u::this_actor::suspend()`,
170 :cpp:func:`simgrid::s4u::Actor::suspend()`, :cpp:func:`simgrid::s4u::Actor::resume()`, and
171 :cpp:func:`simgrid::s4u::Actor::is_suspended()`.
173 .. example-tab:: examples/python/actor-suspend/actor-suspend.py
175 See also :py:func:`simgrid.this_actor.suspend()`,
176 :py:func:`simgrid.Actor.suspend()`, :py:func:`simgrid.Actor.resume()`, and
177 :py:func:`simgrid.Actor.is_suspended()`.
179 .. example-tab:: examples/c/actor-suspend/actor-suspend.c
181 See also :cpp:func:`sg_actor_suspend()`, :cpp:func:`sg_actor_resume()`, and
182 :cpp:func:`sg_actor_is_suspended()`.
184 - **Migrating Actors:**
185 Actors can move or be moved from a host to another very easily. It amount to setting them on a new host.
189 .. example-tab:: examples/s4u/actor-migrate/s4u-actor-migrate.cpp
191 See also :cpp:func:`simgrid::s4u::this_actor::set_host()` and :cpp:func:`simgrid::s4u::Actor::set_host()`.
193 .. example-tab:: examples/python/actor-migrate/actor-migrate.py
195 See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.set_host()`.
197 .. example-tab:: examples/c/actor-migrate/actor-migrate.c
199 See also :cpp:func:`sg_actor_set_host()`.
201 - **Waiting for the termination of an actor:** (joining on it)
202 You can block the current actor until the end of another actor.
206 .. example-tab:: examples/s4u/actor-join/s4u-actor-join.cpp
208 See also :cpp:func:`simgrid::s4u::Actor::join()`.
210 .. example-tab:: examples/python/actor-join/actor-join.py
212 See also :py:func:`simgrid.Actor.join()`.
214 .. example-tab:: examples/c/actor-join/actor-join.c
216 See also :cpp:func:`sg_actor_join`.
218 - **Yielding to other actors**.
219 The ```yield()``` function interrupts the execution of the current
220 actor, leaving a chance to the other actors that are ready to run
225 .. example-tab:: examples/s4u/actor-yield/s4u-actor-yield.cpp
227 See also :cpp:func:`simgrid::s4u::this_actor::yield()`.
229 .. example-tab:: examples/python/actor-yield/actor-yield.py
231 See also :py:func:`simgrid.this_actor.yield_()`.
233 .. example-tab:: examples/c/actor-yield/actor-yield.c
235 See also :cpp:func:`sg_actor_yield()`.
237 Traces Replay as a Workload
238 ---------------------------
240 This section details how to run trace-driven simulations. It is very
241 handy when you want to test an algorithm or protocol that only react
242 to external events. For example, many P2P protocols react to user
243 requests, but do nothing if there is no such event.
245 In such situations, you should write your protocol in C++, and separate
246 the workload that you want to play onto your protocol in a separate
247 text file. Declare a function handling each type of the events in your
248 trace, register them using :cpp:func:`xbt_replay_action_register()` in
249 your main, and then run the simulation.
251 Then, you can either have one trace file containing all your events,
252 or a file per simulated process: the former may be easier to work
253 with, but the second is more efficient on very large traces. Check
254 also the tesh files in the example directories for details.
256 - **Communication replay:**
257 Presents a set of event handlers reproducing classical communication
258 primitives (asynchronous send/receive at the moment).
262 .. example-tab:: examples/s4u/replay-comm/s4u-replay-comm.cpp
265 Presents a set of event handlers reproducing classical I/O
266 primitives (open, read, close).
270 .. example-tab:: examples/s4u/replay-io/s4u-replay-io.cpp
272 ==========================
273 Activities: what Actors do
274 ==========================
276 .. _s4u_ex_communication:
278 Communications on the Network
279 -----------------------------
281 - **Basic asynchronous communications:**
282 Illustrates how to have non-blocking communications, that are
283 communications running in the background leaving the process free
284 to do something else during their completion.
288 .. example-tab:: examples/s4u/async-wait/s4u-async-wait.cpp
290 See also :cpp:func:`simgrid::s4u::Mailbox::put_async()` and :cpp:func:`simgrid::s4u::Comm::wait()`.
292 .. example-tab:: examples/python/async-wait/async-wait.py
294 See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`.
296 .. example-tab:: examples/c/async-wait/async-wait.c
298 See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm__wait()`.
300 - **Waiting for all communications in a set:**
301 The ``wait_all()`` function is useful when you want to block until
302 all activities in a given set have completed.
306 .. example-tab:: examples/s4u/async-waitall/s4u-async-waitall.cpp
308 See also :cpp:func:`simgrid::s4u::Comm::wait_all()`.
310 .. example-tab:: examples/python/async-waitall/async-waitall.py
312 See also :py:func:`simgrid.Comm.wait_all()`.
314 .. example-tab:: examples/c/async-waitall/async-waitall.c
316 See also :cpp:func:`sg_comm_wait_all()`.
318 - **Waiting for the first completed communication in a set:**
319 The ``wait_any()`` function is useful
320 when you want to block until one activity of the set completes, no
321 matter which terminates first.
325 .. example-tab:: examples/s4u/async-waitany/s4u-async-waitany.cpp
327 See also :cpp:func:`simgrid::s4u::Comm::wait_any()`.
329 .. example-tab:: examples/python/async-waitany/async-waitany.py
331 See also :py:func:`simgrid.Comm.wait_any()`.
333 .. example-tab:: examples/c/async-waitany/async-waitany.c
335 See also :cpp:func:`sg_comm_wait_any`.
337 .. _s4u_ex_execution:
339 Executions on the CPU
340 ---------------------
342 - **Basic execution:**
343 The computations done in your program are not reported to the
344 simulated world, unless you explicitly request the simulator to pause
345 the actor until a given amount of flops gets computed on its simulated
346 host. Some executions can be given an higher priority so that they
351 .. example-tab:: examples/s4u/exec-basic/s4u-exec-basic.cpp
353 See also :cpp:func:`void simgrid::s4u::this_actor::execute(double)`
354 and :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`.
356 .. example-tab:: examples/python/exec-basic/exec-basic.py
358 See also :py:func:`simgrid.this_actor.execute()`.
360 .. example-tab:: examples/c/exec-basic/exec-basic.c
362 See also :cpp:func:`void sg_actor_execute(double)`
363 and :cpp:func:`void sg_actor_execute_with_priority(double, double)`.
365 - **Asynchronous execution:**
366 You can start asynchronous executions, just like you would fire
371 .. example-tab:: examples/s4u/exec-async/s4u-exec-async.cpp
373 See also :cpp:func:`simgrid::s4u::this_actor::exec_init()`,
374 :cpp:func:`simgrid::s4u::Activity::start()`,
375 :cpp:func:`simgrid::s4u::Activity::wait()`,
376 :cpp:func:`simgrid::s4u::Activity::get_remaining()`,
377 :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`,
378 :cpp:func:`simgrid::s4u::this_actor::exec_async()` and
379 :cpp:func:`simgrid::s4u::Activity::cancel()`.
381 .. example-tab:: examples/python/exec-async/exec-async.py
383 See also :py:func:`simgrid.this_actor::exec_init()`,
384 :py:func:`simgrid.Activity::start()`,
385 :py:func:`simgrid.Activity.wait()`,
386 :py:func:`simgrid.Activity.get_remaining()`,
387 :py:func:`simgrid.Exec.get_remaining_ratio()`,
388 :py:func:`simgrid.this_actor.exec_async()` and
389 :py:func:`simgrid.Activity.cancel()`.
391 .. example-tab:: examples/c/exec-async/exec-async.c
393 See also :cpp:func:`sg_actor_exec_init()`,
394 :cpp:func:`sg_exec_start()`,
395 :cpp:func:`sg_exec_wait()`,
396 :cpp:func:`sg_exec_get_remaining()`,
397 :cpp:func:`sg_exec_get_remaining_ratio()`,
398 :cpp:func:`sg_actor_exec_async()` and
399 :cpp:func:`sg_exec_cancel()`,
401 - **Remote execution:**
402 You can start executions on remote hosts, or even change the host
403 on which they occur during their execution.
407 .. example-tab:: examples/s4u/exec-remote/s4u-exec-remote.cpp
409 See also :cpp:func:`simgrid::s4u::Exec::set_host()`.
411 .. example-tab:: examples/python/exec-remote/exec-remote.py
413 See also :py:func:`simgrid.Exec.set_host()`.
415 .. example-tab:: examples/c/exec-remote/exec-remote.c
417 See also :cpp:func:`sg_exec_set_host()`.
419 - **Parallel executions:**
420 These objects are convenient abstractions of parallel
421 computational kernels that span over several machines, such as a
422 PDGEM and the other ScaLAPACK routines. Note that this only works
423 with the "ptask_L07" host model (``--cfg=host/model:ptask_L07``).
427 .. example-tab:: examples/s4u/exec-ptask/s4u-exec-ptask.cpp
429 See also :cpp:func:`simgrid::s4u::this_actor::parallel_execute()`.
431 - **Using Pstates on a host:**
432 This example shows how define a set of pstates in the XML. The current pstate
433 of an host can then be accessed and changed from the program.
437 .. example-tab:: examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
439 See also :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`.
441 .. example-tab:: examples/c/exec-dvfs/exec-dvfs.c
443 See also :cpp:func:`sg_host_get_pstate_speed` and :cpp:func:`sg_host_set_pstate`.
445 .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py
447 See also :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`.
449 .. example-tab:: examples/platforms/energy_platform.xml
453 I/O on Disks and Files
454 ----------------------
456 SimGrid provides two levels of abstraction to interact with the
457 simulated disks. At the simplest level, you simply create read and
458 write actions on the disk resources.
460 - **Access to raw disk devices:**
461 This example illustrates how to simply read and write data on a
462 simulated disk resource.
466 .. example-tab:: examples/s4u/io-disk-raw/s4u-io-disk-raw.cpp
468 .. example-tab:: examples/c/io-disk-raw/io-disk-raw.c
470 .. example-tab:: examples/platforms/hosts_with_disks.xml
472 This shows how to declare disks in XML.
474 The FileSystem plugin provides a more detailed view, with the
475 classical operations over files: open, move, unlink, and of course
476 read and write. The file and disk sizes are also dealt with and can
477 result in short reads and short write, as in reality.
479 - **File Management:**
480 This example illustrates the use of operations on files
481 (read, write, seek, tell, unlink, etc).
485 .. example-tab:: examples/s4u/io-file-system/s4u-io-file-system.cpp
488 I/O operations on files can also be done in a remote fashion,
489 i.e. when the accessed disk is not mounted on the caller's host.
493 .. example-tab:: examples/s4u/io-file-remote/s4u-io-file-remote.cpp
495 .. example-tab:: examples/c/io-file-remote/io-file-remote.c
499 Classical synchronization objects
500 ---------------------------------
503 Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
507 .. example-tab:: examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp
509 - **Condition variable:**
510 Shows how to use :cpp:type:`simgrid::s4u::ConditionVariable` synchronization objects.
514 .. example-tab:: examples/s4u/synchro-condition-variable/s4u-synchro-condition-variable.cpp
517 Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
521 .. example-tab:: examples/s4u/synchro-mutex/s4u-synchro-mutex.cpp
524 Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
528 .. example-tab:: examples/s4u/synchro-semaphore/s4u-synchro-semaphore.cpp
530 =============================
531 Interacting with the Platform
532 =============================
534 - **User-defined properties:**
535 You can attach arbitrary information to most platform elements from
536 the XML file, and then interact with these values from your
537 program. Note that the changes are not written permanently on disk,
538 in the XML file nor anywhere else. They only last until the end of
543 .. example-tab:: examples/s4u/platform-properties/s4u-platform-properties.cpp
545 - :cpp:func:`simgrid::s4u::Actor::get_property()` and :cpp:func:`simgrid::s4u::Actor::set_property()`
546 - :cpp:func:`simgrid::s4u::Host::get_property()` and :cpp:func:`simgrid::s4u::Host::set_property()`
547 - :cpp:func:`simgrid::s4u::Link::get_property()` and :cpp:func:`simgrid::s4u::Link::set_property()`
548 - :cpp:func:`simgrid::s4u::NetZone::get_property()` and :cpp:func:`simgrid::s4u::NetZone::set_property()`
550 .. example-tab:: examples/c/platform-properties/platform-properties.c
552 - :cpp:func:`sg_actor_get_property()` and :cpp:func:`sg_actor_set_property()`
553 - :cpp:func:`sg_host_get_property()` and :cpp:func:sg_host_set_property()`
554 - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()`
555 - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()`
561 .. showfile:: examples/s4u/platform-properties/s4u-platform-properties_d.xml
567 .. showfile:: examples/platforms/prop.xml
570 - **Retrieving the netzones matching a given criteria:**
571 Shows how to filter the cluster netzones.
575 .. example-tab:: examples/s4u/routing-get-clusters/s4u-routing-get-clusters.cpp
577 - **Retrieving the list of hosts matching a given criteria:**
578 Shows how to filter the actors that match a given criteria.
582 .. example-tab:: examples/s4u/engine-filtering/s4u-engine-filtering.cpp
584 - **Specifying state profiles:** shows how to specify when the
585 resources must be turned off and on again, and how to react to such
586 failures in your code. See also :ref:`howto_churn`.
590 .. example-tab:: examples/s4u/platform-failures/s4u-platform-failures.cpp
594 .. showfile:: examples/platforms/small_platform_failures.xml
597 .. showfile:: examples/platforms/profiles/jupiter_state.profile
599 .. showfile:: examples/platforms/profiles/bourassa_state.profile
601 .. showfile:: examples/platforms/profiles/fafard_state.profile
603 - **Specifying speed profiles:** shows how to specify an external
604 load to resources, variating their peak speed over time.
608 .. example-tab:: examples/s4u/platform-profile/s4u-platform-profile.cpp
612 .. showfile:: examples/platforms/small_platform_profile.xml
615 .. showfile:: examples/platforms/profiles/jupiter_speed.profile
617 .. showfile:: examples/platforms/profiles/link1_bandwidth.profile
619 .. showfile:: examples/platforms/profiles/link1_latency.profile
625 - **Describing the energy profiles in the platform:**
626 This platform file contains the energy profile of each links and
627 hosts, which is necessary to get energy consumption predictions.
628 As usual, you should not trust our example, and you should strive
629 to double-check that your instantiation matches your target platform.
633 .. example-tab:: examples/platforms/energy_platform.xml
635 - **Consumption due to the CPU:**
636 This example shows how to retrieve the amount of energy consumed
637 by the CPU during computations, and the impact of the pstate.
641 .. example-tab:: examples/s4u/energy-exec/s4u-energy-exec.cpp
643 .. example-tab:: examples/c/energy-exec/energy-exec.c
645 - **Consumption due to the network:**
646 This example shows how to retrieve and display the energy consumed
647 by the network during communications.
651 .. example-tab:: examples/s4u/energy-link/s4u-energy-link.cpp
653 - **Modeling the shutdown and boot of hosts:**
654 Simple example of model of model for the energy consumption during
655 the host boot and shutdown periods.
659 .. example-tab:: examples/s4u/energy-boot/platform_boot.xml
661 .. example-tab:: examples/s4u/energy-boot/s4u-energy-boot.cpp
663 =======================
664 Tracing and Visualizing
665 =======================
667 Tracing can be activated by various configuration options which
668 are illustrated in these example. See also the
669 :ref:`full list of options related to tracing <tracing_tracing_options>`.
671 It is interesting to run the process-create example with the following
672 options to see the task executions:
674 - **Platform Tracing:**
675 This program is a toy example just loading the platform, so that
676 you can play with the platform visualization. Recommanded options:
677 ``--cfg=tracing:yes --cfg=tracing/categorized:yes``
681 .. example-tab:: examples/s4u/trace-platform/s4u-trace-platform.cpp
683 ========================
684 Larger SimGrid Examplars
685 ========================
687 This section contains application examples that are somewhat larger
688 than the previous examples.
691 This simple example just sends one message back and forth.
692 The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
693 the simulators (as detailed in Section :ref:`options`).
697 .. example-tab:: examples/s4u/app-pingpong/s4u-app-pingpong.cpp
699 .. example-tab:: examples/c/app-pingpong/app-pingpong.c
702 Shows how to implement a classical communication pattern, where a
703 token is exchanged along a ring to reach every participant.
707 .. example-tab:: examples/s4u/app-token-ring/s4u-app-token-ring.cpp
709 .. example-tab:: examples/c/app-token-ring/app-token-ring.c
711 - **Master Workers:**
712 Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
719 This example comes in two equivalent variants, one where the actors
720 are specified as simple functions (which is easier to understand for
721 newcomers) and one where the actors are specified as classes (which is
722 more powerful for the users wanting to build their own projects upon
725 .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-class.cpp
728 .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp
735 Classical protocol for Peer-to-Peer data diffusion.
741 .. showfile:: examples/s4u/app-bittorrent/s4u-bittorrent.cpp
744 .. showfile:: examples/s4u/app-bittorrent/s4u-peer.cpp
747 .. showfile:: examples/s4u/app-bittorrent/s4u-tracker.cpp
751 Data broadcast over a ring of processes.
755 .. example-tab:: examples/s4u/app-chainsend/s4u-app-chainsend.cpp
759 .. showfile:: examples/c/app-chainsend/chainsend.c
762 .. showfile:: examples/c/app-chainsend/broadcaster.c
765 .. showfile:: examples/c/app-chainsend/peer.c
768 Distributed Hash Tables (DHT)
769 -----------------------------
772 One of the most famous DHT protocol.
778 .. showfile:: examples/s4u/dht-chord/s4u-dht-chord.cpp
781 .. showfile:: examples/s4u/dht-chord/s4u-dht-chord-node.cpp
785 Another well-known DHT protocol.
791 .. showfile:: examples/s4u/dht-kademlia/s4u-dht-kademlia.cpp
794 .. showfile:: examples/s4u/dht-kademlia/routing_table.cpp
797 .. showfile:: examples/s4u/dht-kademlia/answer.cpp
800 .. showfile:: examples/s4u/dht-kademlia/node.cpp
809 This example starts some computations both on PMs and VMs, and
810 migrates some VMs around.
814 .. example-tab:: examples/s4u/cloud-simple/s4u-cloud-simple.cpp
816 .. example-tab:: examples/c/cloud-simple/cloud-simple.c
819 This example shows how to migrate VMs between PMs.
823 .. example-tab:: examples/s4u/cloud-migration/s4u-cloud-migration.cpp
825 .. example-tab:: examples/c/cloud-migration/cloud-migration.c
827 =======================
828 Model-Checking Examples
829 =======================
831 The model-checker can be used to exhaustively search for issues in the
832 tested application. It must be activated at compile time, but this
833 mode is rather experimental in SimGrid (as of v3.22). You should not
834 enable it unless you really want to formally verify your applications:
835 SimGrid is slower and maybe less robust when MC is enabled.
838 In this example, two actors send some data to a central server,
839 which asserts that the messages are always received in the same order.
840 This is obviously wrong, and the model-checker correctly finds a
841 counter-example to that assertion.
845 .. example-tab:: examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp
851 .. |cpp| image:: /img/lang_cpp.png
855 .. |py| image:: /img/lang_python.png