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 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/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 - **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/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/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/s4u/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/s4u/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/s4u/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/s4u/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/s4u/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/s4u/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/s4u/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/s4u/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 asynchronous communications:**
286 Illustrates how to have non-blocking communications, that are
287 communications running in the background leaving the process free
288 to do something else during their completion.
292 .. example-tab:: examples/s4u/comm-wait/s4u-comm-wait.cpp
294 See also :cpp:func:`simgrid::s4u::Mailbox::put_async()` and :cpp:func:`simgrid::s4u::Comm::wait()`.
296 .. example-tab:: examples/python/comm-wait/comm-wait.py
298 See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`.
300 .. example-tab:: examples/c/comm-wait/comm-wait.c
302 See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm__wait()`.
304 - **Suspending communications:**
305 The ``suspend()`` and ``resume()`` functions allow to block the
306 progression of a given communication for a while and then unblock it.
307 ``is_suspended()`` can be used to retrieve whether the activity is
308 currently blocked or not.
312 .. example-tab:: examples/s4u/comm-suspend/s4u-comm-suspend.cpp
314 See also :cpp:func:`simgrid::s4u::Activity::suspend()`
315 :cpp:func:`simgrid::s4u::Activity::resume()` and
316 :cpp:func:`simgrid::s4u::Activity::is_suspended()`.
319 - **Waiting for all communications in a set:**
320 The ``wait_all()`` function is useful when you want to block until
321 all activities in a given set have completed.
325 .. example-tab:: examples/s4u/comm-waitall/s4u-comm-waitall.cpp
327 See also :cpp:func:`simgrid::s4u::Comm::wait_all()`.
329 .. example-tab:: examples/python/comm-waitall/comm-waitall.py
331 See also :py:func:`simgrid.Comm.wait_all()`.
333 .. example-tab:: examples/c/comm-waitall/comm-waitall.c
335 See also :cpp:func:`sg_comm_wait_all()`.
337 - **Waiting for the first completed communication in a set:**
338 The ``wait_any()`` function is useful
339 when you want to block until one activity of the set completes, no
340 matter which terminates first.
344 .. example-tab:: examples/s4u/comm-waitany/s4u-comm-waitany.cpp
346 See also :cpp:func:`simgrid::s4u::Comm::wait_any()`.
348 .. example-tab:: examples/python/comm-waitany/comm-waitany.py
350 See also :py:func:`simgrid.Comm.wait_any()`.
352 .. example-tab:: examples/c/comm-waitany/comm-waitany.c
354 See also :cpp:func:`sg_comm_wait_any`.
356 .. _s4u_ex_execution:
358 Executions on the CPU
359 ---------------------
361 - **Basic execution:**
362 The computations done in your program are not reported to the
363 simulated world, unless you explicitly request the simulator to pause
364 the actor until a given amount of flops gets computed on its simulated
365 host. Some executions can be given an higher priority so that they
370 .. example-tab:: examples/s4u/exec-basic/s4u-exec-basic.cpp
372 See also :cpp:func:`void simgrid::s4u::this_actor::execute(double)`
373 and :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`.
375 .. example-tab:: examples/python/exec-basic/exec-basic.py
377 See also :py:func:`simgrid.this_actor.execute()`.
379 .. example-tab:: examples/c/exec-basic/exec-basic.c
381 See also :cpp:func:`void sg_actor_execute(double)`
382 and :cpp:func:`void sg_actor_execute_with_priority(double, double)`.
384 - **Asynchronous execution:**
385 You can start asynchronous executions, just like you would fire
390 .. example-tab:: examples/s4u/exec-async/s4u-exec-async.cpp
392 See also :cpp:func:`simgrid::s4u::this_actor::exec_init()`,
393 :cpp:func:`simgrid::s4u::Activity::start()`,
394 :cpp:func:`simgrid::s4u::Activity::wait()`,
395 :cpp:func:`simgrid::s4u::Activity::get_remaining()`,
396 :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`,
397 :cpp:func:`simgrid::s4u::this_actor::exec_async()` and
398 :cpp:func:`simgrid::s4u::Activity::cancel()`.
400 .. example-tab:: examples/python/exec-async/exec-async.py
402 See also :py:func:`simgrid.this_actor::exec_init()`,
403 :py:func:`simgrid.Activity::start()`,
404 :py:func:`simgrid.Activity.wait()`,
405 :py:func:`simgrid.Activity.get_remaining()`,
406 :py:func:`simgrid.Exec.get_remaining_ratio()`,
407 :py:func:`simgrid.this_actor.exec_async()` and
408 :py:func:`simgrid.Activity.cancel()`.
410 .. example-tab:: examples/c/exec-async/exec-async.c
412 See also :cpp:func:`sg_actor_exec_init()`,
413 :cpp:func:`sg_exec_start()`,
414 :cpp:func:`sg_exec_wait()`,
415 :cpp:func:`sg_exec_get_remaining()`,
416 :cpp:func:`sg_exec_get_remaining_ratio()`,
417 :cpp:func:`sg_actor_exec_async()` and
418 :cpp:func:`sg_exec_cancel()`,
420 - **Remote execution:**
421 You can start executions on remote hosts, or even change the host
422 on which they occur during their execution.
426 .. example-tab:: examples/s4u/exec-remote/s4u-exec-remote.cpp
428 See also :cpp:func:`simgrid::s4u::Exec::set_host()`.
430 .. example-tab:: examples/python/exec-remote/exec-remote.py
432 See also :py:func:`simgrid.Exec.set_host()`.
434 .. example-tab:: examples/c/exec-remote/exec-remote.c
436 See also :cpp:func:`sg_exec_set_host()`.
438 - **Parallel executions:**
439 These objects are convenient abstractions of parallel
440 computational kernels that span over several machines, such as a
441 PDGEM and the other ScaLAPACK routines. Note that this only works
442 with the "ptask_L07" host model (``--cfg=host/model:ptask_L07``).
444 This example demonstrates several kind of parallel tasks: regular
445 ones, communication-only (without computation), computation-only
446 (without communication), synchronization-only (neither
447 communication nor computation). It also shows how to reconfigure a
448 task after its start, to change the amount of hosts it runs onto.
449 This allows to simulate malleable tasks.
453 .. example-tab:: examples/s4u/exec-ptask/s4u-exec-ptask.cpp
455 See also :cpp:func:`simgrid::s4u::this_actor::parallel_execute()`.
457 - **Using Pstates on a host:**
458 This example shows how define a set of pstates in the XML. The current pstate
459 of an host can then be accessed and changed from the program.
463 .. example-tab:: examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
465 See also :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`.
467 .. example-tab:: examples/c/exec-dvfs/exec-dvfs.c
469 See also :cpp:func:`sg_host_get_pstate_speed` and :cpp:func:`sg_host_set_pstate`.
471 .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py
473 See also :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`.
475 .. example-tab:: examples/platforms/energy_platform.xml
479 I/O on Disks and Files
480 ----------------------
482 SimGrid provides two levels of abstraction to interact with the
483 simulated disks. At the simplest level, you simply create read and
484 write actions on the disk resources.
486 - **Access to raw disk devices:**
487 This example illustrates how to simply read and write data on a
488 simulated disk resource.
492 .. example-tab:: examples/s4u/io-disk-raw/s4u-io-disk-raw.cpp
494 .. example-tab:: examples/c/io-disk-raw/io-disk-raw.c
496 .. example-tab:: examples/platforms/hosts_with_disks.xml
498 This shows how to declare disks in XML.
500 The FileSystem plugin provides a more detailed view, with the
501 classical operations over files: open, move, unlink, and of course
502 read and write. The file and disk sizes are also dealt with and can
503 result in short reads and short write, as in reality.
505 - **File Management:**
506 This example illustrates the use of operations on files
507 (read, write, seek, tell, unlink, etc).
511 .. example-tab:: examples/s4u/io-file-system/s4u-io-file-system.cpp
514 I/O operations on files can also be done in a remote fashion,
515 i.e. when the accessed disk is not mounted on the caller's host.
519 .. example-tab:: examples/s4u/io-file-remote/s4u-io-file-remote.cpp
521 .. example-tab:: examples/c/io-file-remote/io-file-remote.c
525 Classical synchronization objects
526 ---------------------------------
529 Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
533 .. example-tab:: examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp
535 - **Condition variable:**
536 Shows how to use :cpp:type:`simgrid::s4u::ConditionVariable` synchronization objects.
540 .. example-tab:: examples/s4u/synchro-condition-variable/s4u-synchro-condition-variable.cpp
543 Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
547 .. example-tab:: examples/s4u/synchro-mutex/s4u-synchro-mutex.cpp
550 Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
554 .. example-tab:: examples/s4u/synchro-semaphore/s4u-synchro-semaphore.cpp
556 =============================
557 Interacting with the Platform
558 =============================
560 - **User-defined properties:**
561 You can attach arbitrary information to most platform elements from
562 the XML file, and then interact with these values from your
563 program. Note that the changes are not written permanently on disk,
564 in the XML file nor anywhere else. They only last until the end of
569 .. example-tab:: examples/s4u/platform-properties/s4u-platform-properties.cpp
571 - :cpp:func:`simgrid::s4u::Actor::get_property()` and :cpp:func:`simgrid::s4u::Actor::set_property()`
572 - :cpp:func:`simgrid::s4u::Host::get_property()` and :cpp:func:`simgrid::s4u::Host::set_property()`
573 - :cpp:func:`simgrid::s4u::Link::get_property()` and :cpp:func:`simgrid::s4u::Link::set_property()`
574 - :cpp:func:`simgrid::s4u::NetZone::get_property()` and :cpp:func:`simgrid::s4u::NetZone::set_property()`
576 .. example-tab:: examples/c/platform-properties/platform-properties.c
578 - :cpp:func:`sg_actor_get_property()` and :cpp:func:`sg_actor_set_property()`
579 - :cpp:func:`sg_host_get_property()` and :cpp:func:sg_host_set_property()`
580 - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()`
581 - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()`
587 .. showfile:: examples/s4u/platform-properties/s4u-platform-properties_d.xml
593 .. showfile:: examples/platforms/prop.xml
596 - **Retrieving the netzones matching a given criteria:**
597 Shows how to filter the cluster netzones.
601 .. example-tab:: examples/s4u/routing-get-clusters/s4u-routing-get-clusters.cpp
603 - **Retrieving the list of hosts matching a given criteria:**
604 Shows how to filter the actors that match a given criteria.
608 .. example-tab:: examples/s4u/engine-filtering/s4u-engine-filtering.cpp
610 - **Specifying state profiles:** shows how to specify when the
611 resources must be turned off and on again, and how to react to such
612 failures in your code. See also :ref:`howto_churn`.
616 .. example-tab:: examples/s4u/platform-failures/s4u-platform-failures.cpp
618 .. example-tab:: examples/c/platform-failures/platform-failures.c
622 .. showfile:: examples/platforms/small_platform_failures.xml
625 .. showfile:: examples/platforms/profiles/jupiter_state.profile
627 .. showfile:: examples/platforms/profiles/bourassa_state.profile
629 .. showfile:: examples/platforms/profiles/fafard_state.profile
631 - **Specifying speed profiles:** shows how to specify an external
632 load to resources, variating their peak speed over time.
636 .. example-tab:: examples/s4u/platform-profile/s4u-platform-profile.cpp
640 .. showfile:: examples/platforms/small_platform_profile.xml
643 .. showfile:: examples/platforms/profiles/jupiter_speed.profile
645 .. showfile:: examples/platforms/profiles/link1_bandwidth.profile
647 .. showfile:: examples/platforms/profiles/link1_latency.profile
653 - **Describing the energy profiles in the platform:**
654 The first platform file contains the energy profile of each links and
655 hosts for a wired network, which is necessary to get energy consumption
656 predictions. The second platform file is the equivalent for a wireless
657 network. As usual, you should not trust our example, and you should
658 strive to double-check that your instantiation matches your target
665 .. showfile:: examples/platforms/energy_platform.xml
668 .. showfile:: examples/platforms/wifi_energy.xml
671 - **Consumption due to the CPU:**
672 This example shows how to retrieve the amount of energy consumed
673 by the CPU during computations, and the impact of the pstate.
677 .. example-tab:: examples/s4u/energy-exec/s4u-energy-exec.cpp
679 .. example-tab:: examples/c/energy-exec/energy-exec.c
681 - **Consumption due to the wired network:**
682 This example shows how to retrieve and display the energy consumed
683 by the wired network during communications.
687 .. example-tab:: examples/s4u/energy-link/s4u-energy-link.cpp
689 - **Consumption due to the wireless network:**
690 This example shows how to retrieve and display the energy consumed
691 by the wireless network during communications.
695 .. example-tab:: examples/s4u/energy-wifi/s4u-energy-wifi.cpp
697 - **Modeling the shutdown and boot of hosts:**
698 Simple example of model of model for the energy consumption during
699 the host boot and shutdown periods.
703 .. example-tab:: examples/s4u/energy-boot/platform_boot.xml
705 .. example-tab:: examples/s4u/energy-boot/s4u-energy-boot.cpp
707 =======================
708 Tracing and Visualizing
709 =======================
711 Tracing can be activated by various configuration options which
712 are illustrated in these example. See also the
713 :ref:`full list of options related to tracing <tracing_tracing_options>`.
715 It is interesting to run the process-create example with the following
716 options to see the task executions:
718 - **Platform Tracing:**
719 This program is a toy example just loading the platform, so that
720 you can play with the platform visualization. Recommended options:
721 ``--cfg=tracing:yes --cfg=tracing/categorized:yes``
725 .. example-tab:: examples/s4u/trace-platform/s4u-trace-platform.cpp
727 ========================
728 Larger SimGrid Examplars
729 ========================
731 This section contains application examples that are somewhat larger
732 than the previous examples.
735 This simple example just sends one message back and forth.
736 The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
737 the simulators (as detailed in Section :ref:`options`).
741 .. example-tab:: examples/s4u/app-pingpong/s4u-app-pingpong.cpp
743 .. example-tab:: examples/c/app-pingpong/app-pingpong.c
746 Shows how to implement a classical communication pattern, where a
747 token is exchanged along a ring to reach every participant.
751 .. example-tab:: examples/s4u/app-token-ring/s4u-app-token-ring.cpp
753 .. example-tab:: examples/c/app-token-ring/app-token-ring.c
755 - **Master Workers:**
756 Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
763 This example comes in two equivalent variants, one where the actors
764 are specified as simple functions (which is easier to understand for
765 newcomers) and one where the actors are specified as classes (which is
766 more powerful for the users wanting to build their own projects upon
769 .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-class.cpp
772 .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp
777 .. showfile:: examples/c/app-masterworker/app-masterworker.c
784 Classical protocol for Peer-to-Peer data diffusion.
790 .. showfile:: examples/s4u/app-bittorrent/s4u-bittorrent.cpp
793 .. showfile:: examples/s4u/app-bittorrent/s4u-peer.cpp
796 .. showfile:: examples/s4u/app-bittorrent/s4u-tracker.cpp
801 .. showfile:: examples/c/app-bittorrent/app-bittorrent.c
804 .. showfile:: examples/c/app-bittorrent/bittorrent-peer.c
807 .. showfile:: examples/c/app-bittorrent/tracker.c
811 Data broadcast over a ring of processes.
815 .. example-tab:: examples/s4u/app-chainsend/s4u-app-chainsend.cpp
819 .. showfile:: examples/c/app-chainsend/chainsend.c
822 .. showfile:: examples/c/app-chainsend/broadcaster.c
825 .. showfile:: examples/c/app-chainsend/peer.c
828 Distributed Hash Tables (DHT)
829 -----------------------------
832 One of the most famous DHT protocol.
838 .. showfile:: examples/s4u/dht-chord/s4u-dht-chord.cpp
841 .. showfile:: examples/s4u/dht-chord/s4u-dht-chord-node.cpp
845 Another well-known DHT protocol.
851 .. showfile:: examples/s4u/dht-kademlia/s4u-dht-kademlia.cpp
854 .. showfile:: examples/s4u/dht-kademlia/routing_table.cpp
857 .. showfile:: examples/s4u/dht-kademlia/answer.cpp
860 .. showfile:: examples/s4u/dht-kademlia/node.cpp
865 .. showfile:: examples/c/dht-kademlia/dht-kademlia.c
868 .. showfile:: examples/c/dht-kademlia/routing_table.c
871 .. showfile:: examples/c/dht-kademlia/answer.c
874 .. showfile:: examples/c/dht-kademlia/message.c
877 .. showfile:: examples/c/dht-kademlia/node.c
886 This example starts some computations both on PMs and VMs, and
887 migrates some VMs around.
891 .. example-tab:: examples/s4u/cloud-simple/s4u-cloud-simple.cpp
893 .. example-tab:: examples/c/cloud-simple/cloud-simple.c
896 This example shows how to migrate VMs between PMs.
900 .. example-tab:: examples/s4u/cloud-migration/s4u-cloud-migration.cpp
902 .. example-tab:: examples/c/cloud-migration/cloud-migration.c
904 =======================
905 Model-Related Examples
906 =======================
908 - **ns-3 as a SimGrid Network Model**
909 This simple ping-pong example demonstrates how to use the bindings to the Network
910 Simulator. The most interesting is probably not the C++ files since
911 they are unchanged from the other simulations, but the associated files,
912 such as the platform file to see how to declare a platform to be used
913 with the ns-3 bindings of SimGrid and the tesh file to see how to actually
914 start a simulation in these settings.
918 .. example-tab:: examples/s4u/network-ns3/s4u-network-ns3.cpp
924 .. showfile:: examples/platforms/small_platform_one_link_routes.xml
929 This demonstrates how to declare a wifi link in your platform and
930 how to use it in your simulation. The basics is to have a link
931 which sharing policy is set to `WIFI`. Such links can have more
932 than one bandwidth value (separated by commas), corresponding to
933 the several SNR level of your wifi link.
935 In this case, SimGrid automatically switches to validated
936 performance models of wifi networks, where the time is shared
937 between users instead of the bandwidth for wired links (the
938 corresponding publication is currently being written).
940 If your wifi link provides more than one SNR level, you can switch
941 the level of a given host using
942 :cpp:func:`simgrid::s4u::Link::set_host_wifi_rate`. By default,
943 the first level is used.
947 .. example-tab:: examples/s4u/network-wifi/s4u-network-wifi.cpp
953 .. showfile:: examples/platforms/wifi.xml
960 It is possible to extend SimGrid without modifying its internals by
961 attaching code to the existing signals and by adding extra data to the
962 simulation objects through extensions. How to do that is not exactly
963 documented yet, and you should look for examples in the src/plugins
966 This section documents how the existing plugins can be used. Remember
967 that you are very welcome to modify the plugins to fit your needs. It
968 should be much easier than modifying the SimGrid kernel.
970 - **Monitoring the host load**
974 .. example-tab:: examples/s4u/plugin-host-load/s4u-plugin-host-load.cpp
976 .. example-tab:: examples/c/plugin-host-load/plugin-host-load.c
978 - **Monitoring the link load**
982 .. example-tab:: examples/s4u/plugin-link-load/s4u-plugin-link-load.cpp
984 =======================
985 Model-Checking Examples
986 =======================
988 The model-checker can be used to exhaustively search for issues in the
989 tested application. It must be activated at compile time, but this
990 mode is rather experimental in SimGrid (as of v3.22). You should not
991 enable it unless you really want to formally verify your applications:
992 SimGrid is slower and maybe less robust when MC is enabled.
995 In this example, two actors send some data to a central server,
996 which asserts that the messages are always received in the same order.
997 This is obviously wrong, and the model-checker correctly finds a
998 counter-example to that assertion.
1002 .. example-tab:: examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp
1008 .. |cpp| image:: /img/lang_cpp.png
1012 .. |py| image:: /img/lang_python.png