examples/README.rst

   1 .. S4U (Simgrid for you) is the modern interface of SimGrid, which new project should use.
   2 ..
   3 .. This file follows the ReStructured syntax to be included in the
   4 .. documentation, but it should remain readable directly.
   5
   6
   7 Examples
   8 ********
   9
  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.
  13
  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.
  20
  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
  23 to simulate.
  24
  25 .. _s4u_ex_actors:
  26
  27 ===========================
  28 Actors: the Active Entities
  29 ===========================
  30
  31 Starting and Stoping Actors
  32 ---------------------------
  33
  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.
  38
  39     .. tabs::
  40
  41        .. example-tab:: examples/s4u/actor-create/s4u-actor-create.cpp
  42
  43           You create actors either:
  44
  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`
  49
  50        .. example-tab:: examples/python/actor-create/actor-create.py
  51
  52           You create actors either:
  53
  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()`
  56
  57        .. example-tab:: examples/c/actor-create/actor-create.c
  58
  59           You create actors either:
  60
  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`.
  63
  64        .. example-tab:: examples/python/actor-create/actor-create_d.xml
  65
  66           The following file is used in both C++ and Python.
  67
  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
  73     actors.
  74
  75     .. tabs::
  76
  77        .. example-tab:: examples/s4u/actor-exiting/s4u-actor-exiting.cpp
  78
  79           This example shows how to attach a callback to:
  80
  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()`
  84
  85        .. example-tab:: examples/c/actor-exiting/actor-exiting.c
  86
  87           This example shows how to attach a callback to the end of a specific actor with
  88           :cpp:func:`sg_actor_on_exit()`.
  89
  90   - **Kill actors:**
  91     Actors can forcefully stop other actors.
  92
  93     .. tabs::
  94
  95        .. example-tab:: examples/s4u/actor-kill/s4u-actor-kill.cpp
  96
  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`.
  99
 100        .. example-tab:: examples/python/actor-kill/actor-kill.py
 101
 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`.
 104
 105        .. example-tab:: examples/c/actor-kill/actor-kill.c
 106
 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`.
 108
 109   - **Controling the actor life cycle from the XML:**
 110     You can specify a start time and a kill time in the deployment file.
 111
 112     .. tabs::
 113
 114        .. example-tab:: examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
 115
 116           This file is not really interesting: the important matter is in the XML file.
 117
 118        .. example-tab:: examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
 119
 120           This demonstrates the ``start_time`` and ``kill_time`` attribute of the :ref:`pf_tag_actor` tag.
 121
 122        .. example-tab:: examples/c/actor-lifetime/actor-lifetime.c
 123
 124           This file is not really interesting: the important matter is in the XML file.
 125
 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.
 129
 130     .. tabs::
 131
 132        .. example-tab:: examples/s4u/actor-daemon/s4u-actor-daemon.cpp
 133
 134           See also :cpp:func:`simgrid::s4u::Actor::daemonize()` and :cpp:func:`simgrid::s4u::Actor::is_daemon()`.
 135
 136        .. example-tab:: examples/python/actor-daemon/actor-daemon.py
 137
 138           See also :py:func:`simgrid.Actor.daemonize()` and :py:func:`simgrid.Actor.is_daemon()`.
 139
 140        .. example-tab:: examples/c/actor-daemon/actor-daemon.c
 141
 142           See also :cpp:func:`sg_actor_daemonize` and :cpp:func:`sg_actor_is_daemon`.
 143
 144 Inter-Actors Interactions
 145 -------------------------
 146
 147 See also the examples on :ref:`inter-actors communications
 148 <s4u_ex_communication>` and the ones on :ref:`classical
 149 synchronization objects <s4u_ex_IPC>`.
 150
 151   - **Suspend and Resume actors:**
 152     Actors can be suspended and resumed during their executions.
 153
 154     .. tabs::
 155
 156        .. example-tab:: examples/s4u/actor-suspend/s4u-actor-suspend.cpp
 157
 158           See also :cpp:func:`simgrid::s4u::this_actor::suspend()`,
 159           :cpp:func:`simgrid::s4u::Actor::suspend()`, :cpp:func:`simgrid::s4u::Actor::resume()`, and
 160           :cpp:func:`simgrid::s4u::Actor::is_suspended()`.
 161
 162        .. example-tab:: examples/python/actor-suspend/actor-suspend.py
 163
 164           See also :py:func:`simgrid.this_actor.suspend()`,
 165           :py:func:`simgrid.Actor.suspend()`, :py:func:`simgrid.Actor.resume()`, and
 166           :py:func:`simgrid.Actor.is_suspended()`.
 167
 168        .. example-tab:: examples/c/actor-suspend/actor-suspend.c
 169
 170           See also :cpp:func:`sg_actor_suspend()`, :cpp:func:`sg_actor_resume()`, and
 171           :cpp:func:`sg_actor_is_suspended()`.
 172
 173   - **Migrating Actors:**
 174     Actors can move or be moved from a host to another very easily. It amount to setting them on a new host.
 175
 176     .. tabs::
 177
 178        .. example-tab:: examples/s4u/actor-migrate/s4u-actor-migrate.cpp
 179
 180           See also :cpp:func:`simgrid::s4u::this_actor::set_host()` and :cpp:func:`simgrid::s4u::Actor::set_host()`.
 181
 182        .. example-tab:: examples/python/actor-migrate/actor-migrate.py
 183
 184           See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.set_host()`.
 185
 186        .. example-tab:: examples/c/actor-migrate/actor-migrate.c
 187
 188           See also :cpp:func:`sg_actor_set_host()`.
 189
 190   - **Waiting for the termination of an actor:** (joining on it)
 191     You can block the current actor until the end of another actor.
 192
 193     .. tabs::
 194
 195        .. example-tab:: examples/s4u/actor-join/s4u-actor-join.cpp
 196
 197           See also :cpp:func:`simgrid::s4u::Actor::join()`.
 198
 199        .. example-tab:: examples/python/actor-join/actor-join.py
 200
 201           See also :py:func:`simgrid.Actor.join()`.
 202
 203        .. example-tab:: examples/c/actor-join/actor-join.c
 204
 205           See also :cpp:func:`sg_actor_join`.
 206
 207   - **Yielding to other actors**.
 208     The ```yield()``` function interrupts the execution of the current
 209     actor, leaving a chance to the other actors that are ready to run
 210     at this timestamp.
 211
 212     .. tabs::
 213
 214        .. example-tab:: examples/s4u/actor-yield/s4u-actor-yield.cpp
 215
 216           See also :cpp:func:`simgrid::s4u::this_actor::yield()`.
 217
 218        .. example-tab:: examples/python/actor-yield/actor-yield.py
 219
 220           See also :py:func:`simgrid.this_actor.yield_()`.
 221
 222        .. example-tab:: examples/c/actor-yield/actor-yield.c
 223
 224           See also :cpp:func:`sg_actor_yield()`.
 225
 226 Traces Replay as a Workload
 227 ---------------------------
 228
 229 This section details how to run trace-driven simulations. It is very
 230 handy when you want to test an algorithm or protocol that only react
 231 to external events. For example, many P2P protocols react to user
 232 requests, but do nothing if there is no such event.
 233
 234 In such situations, you should write your protocol in C++, and separate
 235 the workload that you want to play onto your protocol in a separate
 236 text file. Declare a function handling each type of the events in your
 237 trace, register them using :cpp:func:`xbt_replay_action_register()` in
 238 your main, and then run the simulation.
 239
 240 Then, you can either have one trace file containing all your events,
 241 or a file per simulated process: the former may be easier to work
 242 with, but the second is more efficient on very large traces. Check
 243 also the tesh files in the example directories for details.
 244
 245   - **Communication replay:**
 246     Presents a set of event handlers reproducing classical communication
 247     primitives (asynchronous send/receive at the moment).
 248
 249     .. tabs::
 250
 251        .. example-tab:: examples/s4u/replay-comm/s4u-replay-comm.cpp
 252
 253   - **I/O replay:**
 254     Presents a set of event handlers reproducing classical I/O
 255     primitives (open, read, close).
 256
 257     .. tabs::
 258
 259        .. example-tab:: examples/s4u/replay-io/s4u-replay-io.cpp
 260
 261 ==========================
 262 Activities: what Actors do
 263 ==========================
 264
 265 .. _s4u_ex_communication:
 266
 267 Communications on the Network
 268 -----------------------------
 269
 270  - **Basic asynchronous communications:**
 271    Illustrates how to have non-blocking communications, that are
 272    communications running in the background leaving the process free
 273    to do something else during their completion.
 274
 275    .. tabs::
 276
 277       .. example-tab:: examples/s4u/async-wait/s4u-async-wait.cpp
 278
 279          See also :cpp:func:`simgrid::s4u::Mailbox::put_async()` and :cpp:func:`simgrid::s4u::Comm::wait()`.
 280
 281       .. example-tab:: examples/python/async-wait/async-wait.py
 282
 283          See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`.
 284
 285       .. example-tab:: examples/c/async-wait/async-wait.c
 286
 287          See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm__wait()`.
 288
 289  - **Waiting for all communications in a set:**
 290    The ``wait_all()`` function is useful when you want to block until
 291    all activities in a given set have completed.
 292
 293    .. tabs::
 294
 295       .. example-tab:: examples/s4u/async-waitall/s4u-async-waitall.cpp
 296
 297          See also :cpp:func:`simgrid::s4u::Comm::wait_all()`.
 298
 299       .. example-tab:: examples/python/async-waitall/async-waitall.py
 300
 301          See also :py:func:`simgrid.Comm.wait_all()`.
 302
 303       .. example-tab:: examples/c/async-waitall/async-waitall.c
 304
 305          See also :cpp:func:`sg_comm_wait_all()`.
 306
 307  - **Waiting for the first completed communication in a set:**
 308    The ``wait_any()`` function is useful
 309    when you want to block until one activity of the set completes, no
 310    matter which terminates first.
 311
 312    .. tabs::
 313
 314       .. example-tab:: examples/s4u/async-waitany/s4u-async-waitany.cpp
 315
 316          See also :cpp:func:`simgrid::s4u::Comm::wait_any()`.
 317
 318       .. example-tab:: examples/python/async-waitany/async-waitany.py
 319
 320          See also :py:func:`simgrid.Comm.wait_any()`.
 321
 322       .. example-tab:: examples/c/async-waitany/async-waitany.c
 323
 324          See also :cpp:func:`sg_comm_wait_any`.
 325
 326 .. _s4u_ex_execution:
 327
 328 Executions on the CPU
 329 ---------------------
 330
 331   - **Basic execution:**
 332     The computations done in your program are not reported to the
 333     simulated world, unless you explicitly request the simulator to pause
 334     the actor until a given amount of flops gets computed on its simulated
 335     host. Some executions can be given an higher priority so that they
 336     get more resources.
 337
 338     .. tabs::
 339
 340        .. example-tab:: examples/s4u/exec-basic/s4u-exec-basic.cpp
 341
 342           See also :cpp:func:`void simgrid::s4u::this_actor::execute(double)`
 343           and :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`.
 344
 345        .. example-tab:: examples/python/exec-basic/exec-basic.py
 346
 347           See also :py:func:`simgrid.this_actor.execute()`.
 348
 349        .. example-tab:: examples/c/exec-basic/exec-basic.c
 350
 351           See also :cpp:func:`void sg_actor_execute(double)`
 352           and :cpp:func:`void sg_actor_execute_with_priority(double, double)`.
 353
 354   - **Asynchronous execution:**
 355     You can start asynchronous executions, just like you would fire
 356     background threads.
 357
 358     .. tabs::
 359
 360        .. example-tab:: examples/s4u/exec-async/s4u-exec-async.cpp
 361
 362           See also :cpp:func:`simgrid::s4u::this_actor::exec_init()`,
 363           :cpp:func:`simgrid::s4u::Activity::start()`,
 364           :cpp:func:`simgrid::s4u::Activity::wait()`,
 365           :cpp:func:`simgrid::s4u::Activity::get_remaining()`,
 366           :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`,
 367           :cpp:func:`simgrid::s4u::this_actor::exec_async()` and
 368           :cpp:func:`simgrid::s4u::Activity::cancel()`.
 369
 370        .. example-tab:: examples/python/exec-async/exec-async.py
 371
 372           See also :py:func:`simgrid.this_actor::exec_init()`,
 373           :py:func:`simgrid.Activity::start()`,
 374           :py:func:`simgrid.Activity.wait()`,
 375           :py:func:`simgrid.Activity.get_remaining()`,
 376           :py:func:`simgrid.Exec.get_remaining_ratio()`,
 377           :py:func:`simgrid.this_actor.exec_async()` and
 378           :py:func:`simgrid.Activity.cancel()`.
 379
 380   - **Remote execution:**
 381     You can start executions on remote hosts, or even change the host
 382     on which they occur during their execution.
 383
 384     .. tabs::
 385
 386        .. example-tab:: examples/s4u/exec-remote/s4u-exec-remote.cpp
 387
 388           See also :cpp:func:`simgrid::s4u::Exec::set_host()`.
 389
 390        .. example-tab:: examples/python/exec-remote/exec-remote.py
 391
 392           See also :py:func:`simgrid.Exec.set_host()`.
 393
 394        .. example-tab:: examples/c/exec-remote/exec-remote.c
 395
 396           See also :cpp:func:`sg_exec_set_host()`.
 397
 398   - **Parallel executions:**
 399     These objects are convenient abstractions of parallel
 400     computational kernels that span over several machines, such as a
 401     PDGEM and the other ScaLAPACK routines. Note that this only works
 402     with the "ptask_L07" host model (``--cfg=host/model:ptask_L07``).
 403
 404     .. tabs::
 405
 406        .. example-tab:: examples/s4u/exec-ptask/s4u-exec-ptask.cpp
 407
 408           See also :cpp:func:`simgrid::s4u::this_actor::parallel_execute()`.
 409
 410   - **Using Pstates on a host:**
 411     This example shows how define a set of pstates in the XML. The current pstate
 412     of an host can then be accessed and changed from the program.
 413
 414     .. tabs::
 415
 416        .. example-tab:: examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
 417
 418           See also :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`.
 419
 420        .. example-tab:: examples/c/exec-dvfs/exec-dvfs.c
 421
 422           See also :cpp:func:`sg_host_get_pstate_speed` and :cpp:func:`sg_host_set_pstate`.
 423
 424        .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py
 425
 426           See also :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`.
 427
 428        .. example-tab:: examples/platforms/energy_platform.xml
 429
 430 .. _s4u_ex_disk_io:
 431
 432 I/O on Disks and Files
 433 ----------------------
 434
 435 SimGrid provides two levels of abstraction to interact with the
 436 simulated disks. At the simplest level, you simply create read and
 437 write actions on the disk resources.
 438
 439   - **Access to raw disk devices:**
 440     This example illustrates how to simply read and write data on a
 441     simulated disk resource.
 442
 443     .. tabs::
 444
 445        .. example-tab:: examples/s4u/io-disk-raw/s4u-io-disk-raw.cpp
 446
 447        .. example-tab:: examples/c/io-disk-raw/io-disk-raw.c
 448
 449        .. example-tab:: examples/platforms/hosts_with_disks.xml
 450
 451           This shows how to declare disks in XML.
 452
 453 The FileSystem plugin provides a more detailed view, with the
 454 classical operations over files: open, move, unlink, and of course
 455 read and write. The file and disk sizes are also dealt with and can
 456 result in short reads and short write, as in reality.
 457
 458   - **File Management:**
 459     This example illustrates the use of operations on files
 460     (read, write, seek, tell, unlink, etc).
 461
 462     .. tabs::
 463
 464        .. example-tab:: examples/s4u/io-file-system/s4u-io-file-system.cpp
 465
 466   - **Remote I/O:**
 467     I/O operations on files can also be done in a remote fashion,
 468     i.e. when the accessed disk is not mounted on the caller's host.
 469
 470     .. tabs::
 471
 472        .. example-tab:: examples/s4u/io-file-remote/s4u-io-file-remote.cpp
 473
 474        .. example-tab:: examples/c/io-file-remote/io-file-remote.c
 475
 476 .. _s4u_ex_IPC:
 477
 478 Classical synchronization objects
 479 ---------------------------------
 480
 481  - **Barrier:**
 482    Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
 483
 484    .. tabs::
 485
 486       .. example-tab:: examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp
 487
 488  - **Condition variable:**
 489    Shows how to use :cpp:type:`simgrid::s4u::ConditionVariable` synchronization objects.
 490
 491    .. tabs::
 492
 493       .. example-tab:: examples/s4u/synchro-condition-variable/s4u-synchro-condition-variable.cpp
 494
 495  - **Mutex:**
 496    Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
 497
 498    .. tabs::
 499
 500       .. example-tab:: examples/s4u/synchro-mutex/s4u-synchro-mutex.cpp
 501
 502  - **Semaphore:**
 503    Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
 504
 505    .. tabs::
 506
 507       .. example-tab:: examples/s4u/synchro-semaphore/s4u-synchro-semaphore.cpp
 508
 509 =============================
 510 Interacting with the Platform
 511 =============================
 512
 513  - **User-defined properties:**
 514    You can attach arbitrary information to most platform elements from
 515    the XML file, and then interact with these values from your
 516    program. Note that the changes are not written permanently on disk,
 517    in the XML file nor anywhere else. They only last until the end of
 518    your simulation.
 519
 520    .. tabs::
 521
 522       .. example-tab:: examples/s4u/platform-properties/s4u-platform-properties.cpp
 523
 524          - :cpp:func:`simgrid::s4u::Actor::get_property()` and :cpp:func:`simgrid::s4u::Actor::set_property()`
 525          - :cpp:func:`simgrid::s4u::Host::get_property()` and :cpp:func:`simgrid::s4u::Host::set_property()`
 526          - :cpp:func:`simgrid::s4u::Link::get_property()` and :cpp:func:`simgrid::s4u::Link::set_property()`
 527          - :cpp:func:`simgrid::s4u::NetZone::get_property()` and :cpp:func:`simgrid::s4u::NetZone::set_property()`
 528
 529       .. group-tab:: XML
 530
 531          **Deployment file:**
 532
 533          .. showfile:: examples/s4u/platform-properties/s4u-platform-properties_d.xml
 534             :language: xml
 535
 536          |br|
 537          **Platform file:**
 538
 539          .. showfile:: examples/platforms/prop.xml
 540             :language: xml
 541
 542  - **Retrieving the netzones matching a given criteria:**
 543    Shows how to filter the cluster netzones.
 544
 545    .. tabs::
 546
 547       .. example-tab:: examples/s4u/routing-get-clusters/s4u-routing-get-clusters.cpp
 548
 549  - **Retrieving the list of hosts matching a given criteria:**
 550    Shows how to filter the actors that match a given criteria.
 551
 552    .. tabs::
 553
 554       .. example-tab:: examples/s4u/engine-filtering/s4u-engine-filtering.cpp
 555
 556  - **Specifying state profiles:** shows how to specify when the
 557    resources must be turned off and on again, and how to react to such
 558    failures in your code. See also :ref:`howto_churn`.
 559
 560    .. tabs::
 561
 562       .. example-tab:: examples/s4u/platform-failures/s4u-platform-failures.cpp
 563
 564       .. group-tab:: XML
 565
 566          .. showfile:: examples/platforms/small_platform_failures.xml
 567             :language: xml
 568
 569          .. showfile:: examples/platforms/profiles/jupiter_state.profile
 570
 571          .. showfile:: examples/platforms/profiles/bourassa_state.profile
 572
 573          .. showfile:: examples/platforms/profiles/fafard_state.profile
 574
 575  - **Specifying speed profiles:** shows how to specify an external
 576    load to resources, variating their peak speed over time.
 577
 578    .. tabs::
 579
 580       .. example-tab:: examples/s4u/platform-profile/s4u-platform-profile.cpp
 581
 582       .. group-tab:: XML
 583
 584          .. showfile:: examples/platforms/small_platform_profile.xml
 585             :language: xml
 586
 587          .. showfile:: examples/platforms/profiles/jupiter_speed.profile
 588
 589          .. showfile:: examples/platforms/profiles/link1_bandwidth.profile
 590
 591          .. showfile:: examples/platforms/profiles/link1_latency.profile
 592
 593 =================
 594 Energy Simulation
 595 =================
 596
 597   - **Describing the energy profiles in the platform:**
 598     This platform file contains the energy profile of each links and
 599     hosts, which is necessary to get energy consumption predictions.
 600     As usual, you should not trust our example, and you should strive
 601     to double-check that your instantiation matches your target platform.
 602
 603     .. tabs::
 604
 605        .. example-tab:: examples/platforms/energy_platform.xml
 606
 607   - **Consumption due to the CPU:**
 608     This example shows how to retrieve the amount of energy consumed
 609     by the CPU during computations, and the impact of the pstate.
 610
 611     .. tabs::
 612
 613        .. example-tab:: examples/s4u/energy-exec/s4u-energy-exec.cpp
 614
 615        .. example-tab:: examples/c/energy-exec/energy-exec.c
 616
 617   - **Consumption due to the network:**
 618     This example shows how to retrieve and display the energy consumed
 619     by the network during communications.
 620
 621     .. tabs::
 622
 623        .. example-tab:: examples/s4u/energy-link/s4u-energy-link.cpp
 624
 625   - **Modeling the shutdown and boot of hosts:**
 626     Simple example of model of model for the energy consumption during
 627     the host boot and shutdown periods.
 628
 629     .. tabs::
 630
 631        .. example-tab:: examples/s4u/energy-boot/platform_boot.xml
 632
 633        .. example-tab:: examples/s4u/energy-boot/s4u-energy-boot.cpp
 634
 635 =======================
 636 Tracing and Visualizing
 637 =======================
 638
 639 Tracing can be activated by various configuration options which
 640 are illustrated in these example. See also the
 641 :ref:`full list of options related to tracing <tracing_tracing_options>`.
 642
 643 It is interesting to run the process-create example with the following
 644 options to see the task executions:
 645
 646   - **Platform Tracing:**
 647     This program is a toy example just loading the platform, so that
 648     you can play with the platform visualization. Recommanded options:
 649     ``--cfg=tracing:yes --cfg=tracing/categorized:yes``
 650
 651     .. tabs::
 652
 653        .. example-tab:: examples/s4u/trace-platform/s4u-trace-platform.cpp
 654
 655 ========================
 656 Larger SimGrid Examplars
 657 ========================
 658
 659 This section contains application examples that are somewhat larger
 660 than the previous examples.
 661
 662   - **Ping Pong:**
 663     This simple example just sends one message back and forth.
 664     The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
 665     the simulators (as detailed in Section :ref:`options`).
 666
 667     .. tabs::
 668
 669        .. example-tab:: examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 670
 671        .. example-tab:: examples/c/app-pingpong/app-pingpong.c
 672
 673   - **Token ring:**
 674     Shows how to implement a classical communication pattern, where a
 675     token is exchanged along a ring to reach every participant.
 676
 677     .. tabs::
 678
 679        .. example-tab:: examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 680
 681        .. example-tab:: examples/c/app-token-ring/app-token-ring.c
 682
 683   - **Master Workers:**
 684     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
 685     processes.
 686
 687     .. tabs::
 688
 689        .. group-tab:: C++
 690
 691           This example comes in two equivalent variants, one where the actors
 692           are specified as simple functions (which is easier to understand for
 693           newcomers) and one where the actors are specified as classes (which is
 694           more powerful for the users wanting to build their own projects upon
 695           the example).
 696
 697           .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-class.cpp
 698              :language: cpp
 699
 700           .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp
 701              :language: cpp
 702
 703 Data diffusion
 704 --------------
 705
 706   - **Bit Torrent:**
 707     Classical protocol for Peer-to-Peer data diffusion.
 708
 709     .. tabs::
 710
 711        .. group-tab:: C++
 712
 713           .. showfile:: examples/s4u/app-bittorrent/s4u-bittorrent.cpp
 714              :language: cpp
 715
 716           .. showfile:: examples/s4u/app-bittorrent/s4u-peer.cpp
 717              :language: cpp
 718
 719           .. showfile:: examples/s4u/app-bittorrent/s4u-tracker.cpp
 720              :language: cpp
 721
 722   - **Chained Send:**
 723     Data broadcast over a ring of processes.
 724
 725     .. tabs::
 726
 727        .. example-tab:: examples/s4u/app-chainsend/s4u-app-chainsend.cpp
 728
 729        .. group-tab:: C
 730
 731           .. showfile:: examples/c/app-chainsend/chainsend.c
 732              :language: c
 733
 734           .. showfile:: examples/c/app-chainsend/broadcaster.c
 735              :language: c
 736
 737           .. showfile:: examples/c/app-chainsend/peer.c
 738              :language: c
 739
 740 Distributed Hash Tables (DHT)
 741 -----------------------------
 742
 743   - **Chord Protocol**
 744     One of the most famous DHT protocol.
 745
 746     .. tabs::
 747
 748        .. group-tab:: C++
 749
 750           .. showfile:: examples/s4u/dht-chord/s4u-dht-chord.cpp
 751              :language: cpp
 752
 753           .. showfile:: examples/s4u/dht-chord/s4u-dht-chord-node.cpp
 754              :language: cpp
 755
 756   - **Kademlia**
 757     Another well-known DHT protocol.
 758
 759     .. tabs::
 760
 761        .. group-tab:: C++
 762
 763           .. showfile:: examples/s4u/dht-kademlia/s4u-dht-kademlia.cpp
 764              :language: cpp
 765
 766           .. showfile:: examples/s4u/dht-kademlia/routing_table.cpp
 767              :language: cpp
 768
 769           .. showfile:: examples/s4u/dht-kademlia/answer.cpp
 770              :language: cpp
 771
 772           .. showfile:: examples/s4u/dht-kademlia/node.cpp
 773              :language: cpp
 774
 775 .. _s4u_ex_clouds:
 776
 777 Simulating Clouds
 778 -----------------
 779
 780   - **Cloud basics**
 781     This example starts some computations both on PMs and VMs, and
 782     migrates some VMs around.
 783
 784     .. tabs::
 785
 786        .. example-tab:: examples/s4u/cloud-simple/s4u-cloud-simple.cpp
 787
 788        .. example-tab:: examples/c/cloud-simple/cloud-simple.c
 789
 790   - **Migrating VMs**
 791     This example shows how to migrate VMs between PMs.
 792
 793     .. tabs::
 794
 795        .. example-tab:: examples/s4u/cloud-migration/s4u-cloud-migration.cpp
 796
 797        .. example-tab:: examples/c/cloud-migration/cloud-migration.c
 798
 799 =======================
 800 Model-Checking Examples
 801 =======================
 802
 803 The model-checker can be used to exhaustively search for issues in the
 804 tested application. It must be activated at compile time, but this
 805 mode is rather experimental in SimGrid (as of v3.22). You should not
 806 enable it unless you really want to formally verify your applications:
 807 SimGrid is slower and maybe less robust when MC is enabled.
 808
 809   - **Failing assert**
 810     In this example, two actors send some data to a central server,
 811     which asserts that the messages are always received in the same order.
 812     This is obviously wrong, and the model-checker correctly finds a
 813     counter-example to that assertion.
 814
 815     .. tabs::
 816
 817        .. example-tab:: examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp
 818
 819 .. |br| raw:: html
 820
 821    <br />
 822
 823 .. |cpp| image:: /img/lang_cpp.png
 824    :align: middle
 825    :width: 12
 826
 827 .. |py| image:: /img/lang_python.png
 828    :align: middle
 829    :width: 12