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   - **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.
 148
 149     .. tabs::
 150
 151        .. example-tab:: examples/s4u/actor-stacksize/s4u-actor-stacksize.cpp
 152
 153        .. example-tab:: examples/c/actor-stacksize/actor-stacksize.c
 154
 155 Inter-Actors Interactions
 156 -------------------------
 157
 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>`.
 161
 162   - **Suspend and Resume actors:**
 163     Actors can be suspended and resumed during their executions.
 164
 165     .. tabs::
 166
 167        .. example-tab:: examples/s4u/actor-suspend/s4u-actor-suspend.cpp
 168
 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()`.
 172
 173        .. example-tab:: examples/python/actor-suspend/actor-suspend.py
 174
 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()`.
 178
 179        .. example-tab:: examples/c/actor-suspend/actor-suspend.c
 180
 181           See also :cpp:func:`sg_actor_suspend()`, :cpp:func:`sg_actor_resume()`, and
 182           :cpp:func:`sg_actor_is_suspended()`.
 183
 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.
 186
 187     .. tabs::
 188
 189        .. example-tab:: examples/s4u/actor-migrate/s4u-actor-migrate.cpp
 190
 191           See also :cpp:func:`simgrid::s4u::this_actor::set_host()` and :cpp:func:`simgrid::s4u::Actor::set_host()`.
 192
 193        .. example-tab:: examples/python/actor-migrate/actor-migrate.py
 194
 195           See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.set_host()`.
 196
 197        .. example-tab:: examples/c/actor-migrate/actor-migrate.c
 198
 199           See also :cpp:func:`sg_actor_set_host()`.
 200
 201   - **Waiting for the termination of an actor:** (joining on it)
 202     You can block the current actor until the end of another actor.
 203
 204     .. tabs::
 205
 206        .. example-tab:: examples/s4u/actor-join/s4u-actor-join.cpp
 207
 208           See also :cpp:func:`simgrid::s4u::Actor::join()`.
 209
 210        .. example-tab:: examples/python/actor-join/actor-join.py
 211
 212           See also :py:func:`simgrid.Actor.join()`.
 213
 214        .. example-tab:: examples/c/actor-join/actor-join.c
 215
 216           See also :cpp:func:`sg_actor_join`.
 217
 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
 221     at this timestamp.
 222
 223     .. tabs::
 224
 225        .. example-tab:: examples/s4u/actor-yield/s4u-actor-yield.cpp
 226
 227           See also :cpp:func:`simgrid::s4u::this_actor::yield()`.
 228
 229        .. example-tab:: examples/python/actor-yield/actor-yield.py
 230
 231           See also :py:func:`simgrid.this_actor.yield_()`.
 232
 233        .. example-tab:: examples/c/actor-yield/actor-yield.c
 234
 235           See also :cpp:func:`sg_actor_yield()`.
 236
 237 Traces Replay as a Workload
 238 ---------------------------
 239
 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.
 244
 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.
 250
 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.
 255
 256   - **Communication replay:**
 257     Presents a set of event handlers reproducing classical communication
 258     primitives (asynchronous send/receive at the moment).
 259
 260     .. tabs::
 261
 262        .. example-tab:: examples/s4u/replay-comm/s4u-replay-comm.cpp
 263
 264   - **I/O replay:**
 265     Presents a set of event handlers reproducing classical I/O
 266     primitives (open, read, close).
 267
 268     .. tabs::
 269
 270        .. example-tab:: examples/s4u/replay-io/s4u-replay-io.cpp
 271
 272 ==========================
 273 Activities: what Actors do
 274 ==========================
 275
 276 .. _s4u_ex_communication:
 277
 278 Communications on the Network
 279 -----------------------------
 280
 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.
 285
 286    .. tabs::
 287
 288       .. example-tab:: examples/s4u/async-wait/s4u-async-wait.cpp
 289
 290          See also :cpp:func:`simgrid::s4u::Mailbox::put_async()` and :cpp:func:`simgrid::s4u::Comm::wait()`.
 291
 292       .. example-tab:: examples/python/async-wait/async-wait.py
 293
 294          See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`.
 295
 296       .. example-tab:: examples/c/async-wait/async-wait.c
 297
 298          See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm__wait()`.
 299
 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.
 303
 304    .. tabs::
 305
 306       .. example-tab:: examples/s4u/async-waitall/s4u-async-waitall.cpp
 307
 308          See also :cpp:func:`simgrid::s4u::Comm::wait_all()`.
 309
 310       .. example-tab:: examples/python/async-waitall/async-waitall.py
 311
 312          See also :py:func:`simgrid.Comm.wait_all()`.
 313
 314       .. example-tab:: examples/c/async-waitall/async-waitall.c
 315
 316          See also :cpp:func:`sg_comm_wait_all()`.
 317
 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.
 322
 323    .. tabs::
 324
 325       .. example-tab:: examples/s4u/async-waitany/s4u-async-waitany.cpp
 326
 327          See also :cpp:func:`simgrid::s4u::Comm::wait_any()`.
 328
 329       .. example-tab:: examples/python/async-waitany/async-waitany.py
 330
 331          See also :py:func:`simgrid.Comm.wait_any()`.
 332
 333       .. example-tab:: examples/c/async-waitany/async-waitany.c
 334
 335          See also :cpp:func:`sg_comm_wait_any`.
 336
 337 .. _s4u_ex_execution:
 338
 339 Executions on the CPU
 340 ---------------------
 341
 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
 347     get more resources.
 348
 349     .. tabs::
 350
 351        .. example-tab:: examples/s4u/exec-basic/s4u-exec-basic.cpp
 352
 353           See also :cpp:func:`void simgrid::s4u::this_actor::execute(double)`
 354           and :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`.
 355
 356        .. example-tab:: examples/python/exec-basic/exec-basic.py
 357
 358           See also :py:func:`simgrid.this_actor.execute()`.
 359
 360        .. example-tab:: examples/c/exec-basic/exec-basic.c
 361
 362           See also :cpp:func:`void sg_actor_execute(double)`
 363           and :cpp:func:`void sg_actor_execute_with_priority(double, double)`.
 364
 365   - **Asynchronous execution:**
 366     You can start asynchronous executions, just like you would fire
 367     background threads.
 368
 369     .. tabs::
 370
 371        .. example-tab:: examples/s4u/exec-async/s4u-exec-async.cpp
 372
 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()`.
 380
 381        .. example-tab:: examples/python/exec-async/exec-async.py
 382
 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()`.
 390
 391        .. example-tab:: examples/c/exec-async/exec-async.c
 392
 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()`,
 400
 401   - **Remote execution:**
 402     You can start executions on remote hosts, or even change the host
 403     on which they occur during their execution.
 404
 405     .. tabs::
 406
 407        .. example-tab:: examples/s4u/exec-remote/s4u-exec-remote.cpp
 408
 409           See also :cpp:func:`simgrid::s4u::Exec::set_host()`.
 410
 411        .. example-tab:: examples/python/exec-remote/exec-remote.py
 412
 413           See also :py:func:`simgrid.Exec.set_host()`.
 414
 415        .. example-tab:: examples/c/exec-remote/exec-remote.c
 416
 417           See also :cpp:func:`sg_exec_set_host()`.
 418
 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``).
 424
 425     .. tabs::
 426
 427        .. example-tab:: examples/s4u/exec-ptask/s4u-exec-ptask.cpp
 428
 429           See also :cpp:func:`simgrid::s4u::this_actor::parallel_execute()`.
 430
 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.
 434
 435     .. tabs::
 436
 437        .. example-tab:: examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
 438
 439           See also :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`.
 440
 441        .. example-tab:: examples/c/exec-dvfs/exec-dvfs.c
 442
 443           See also :cpp:func:`sg_host_get_pstate_speed` and :cpp:func:`sg_host_set_pstate`.
 444
 445        .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py
 446
 447           See also :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`.
 448
 449        .. example-tab:: examples/platforms/energy_platform.xml
 450
 451 .. _s4u_ex_disk_io:
 452
 453 I/O on Disks and Files
 454 ----------------------
 455
 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.
 459
 460   - **Access to raw disk devices:**
 461     This example illustrates how to simply read and write data on a
 462     simulated disk resource.
 463
 464     .. tabs::
 465
 466        .. example-tab:: examples/s4u/io-disk-raw/s4u-io-disk-raw.cpp
 467
 468        .. example-tab:: examples/c/io-disk-raw/io-disk-raw.c
 469
 470        .. example-tab:: examples/platforms/hosts_with_disks.xml
 471
 472           This shows how to declare disks in XML.
 473
 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.
 478
 479   - **File Management:**
 480     This example illustrates the use of operations on files
 481     (read, write, seek, tell, unlink, etc).
 482
 483     .. tabs::
 484
 485        .. example-tab:: examples/s4u/io-file-system/s4u-io-file-system.cpp
 486
 487   - **Remote I/O:**
 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.
 490
 491     .. tabs::
 492
 493        .. example-tab:: examples/s4u/io-file-remote/s4u-io-file-remote.cpp
 494
 495        .. example-tab:: examples/c/io-file-remote/io-file-remote.c
 496
 497 .. _s4u_ex_IPC:
 498
 499 Classical synchronization objects
 500 ---------------------------------
 501
 502  - **Barrier:**
 503    Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
 504
 505    .. tabs::
 506
 507       .. example-tab:: examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp
 508
 509  - **Condition variable:**
 510    Shows how to use :cpp:type:`simgrid::s4u::ConditionVariable` synchronization objects.
 511
 512    .. tabs::
 513
 514       .. example-tab:: examples/s4u/synchro-condition-variable/s4u-synchro-condition-variable.cpp
 515
 516  - **Mutex:**
 517    Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
 518
 519    .. tabs::
 520
 521       .. example-tab:: examples/s4u/synchro-mutex/s4u-synchro-mutex.cpp
 522
 523  - **Semaphore:**
 524    Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
 525
 526    .. tabs::
 527
 528       .. example-tab:: examples/s4u/synchro-semaphore/s4u-synchro-semaphore.cpp
 529
 530 =============================
 531 Interacting with the Platform
 532 =============================
 533
 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
 539    your simulation.
 540
 541    .. tabs::
 542
 543       .. example-tab:: examples/s4u/platform-properties/s4u-platform-properties.cpp
 544
 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()`
 549
 550       .. group-tab:: XML
 551
 552          **Deployment file:**
 553
 554          .. showfile:: examples/s4u/platform-properties/s4u-platform-properties_d.xml
 555             :language: xml
 556
 557          |br|
 558          **Platform file:**
 559
 560          .. showfile:: examples/platforms/prop.xml
 561             :language: xml
 562
 563  - **Retrieving the netzones matching a given criteria:**
 564    Shows how to filter the cluster netzones.
 565
 566    .. tabs::
 567
 568       .. example-tab:: examples/s4u/routing-get-clusters/s4u-routing-get-clusters.cpp
 569
 570  - **Retrieving the list of hosts matching a given criteria:**
 571    Shows how to filter the actors that match a given criteria.
 572
 573    .. tabs::
 574
 575       .. example-tab:: examples/s4u/engine-filtering/s4u-engine-filtering.cpp
 576
 577  - **Specifying state profiles:** shows how to specify when the
 578    resources must be turned off and on again, and how to react to such
 579    failures in your code. See also :ref:`howto_churn`.
 580
 581    .. tabs::
 582
 583       .. example-tab:: examples/s4u/platform-failures/s4u-platform-failures.cpp
 584
 585       .. group-tab:: XML
 586
 587          .. showfile:: examples/platforms/small_platform_failures.xml
 588             :language: xml
 589
 590          .. showfile:: examples/platforms/profiles/jupiter_state.profile
 591
 592          .. showfile:: examples/platforms/profiles/bourassa_state.profile
 593
 594          .. showfile:: examples/platforms/profiles/fafard_state.profile
 595
 596  - **Specifying speed profiles:** shows how to specify an external
 597    load to resources, variating their peak speed over time.
 598
 599    .. tabs::
 600
 601       .. example-tab:: examples/s4u/platform-profile/s4u-platform-profile.cpp
 602
 603       .. group-tab:: XML
 604
 605          .. showfile:: examples/platforms/small_platform_profile.xml
 606             :language: xml
 607
 608          .. showfile:: examples/platforms/profiles/jupiter_speed.profile
 609
 610          .. showfile:: examples/platforms/profiles/link1_bandwidth.profile
 611
 612          .. showfile:: examples/platforms/profiles/link1_latency.profile
 613
 614 =================
 615 Energy Simulation
 616 =================
 617
 618   - **Describing the energy profiles in the platform:**
 619     This platform file contains the energy profile of each links and
 620     hosts, which is necessary to get energy consumption predictions.
 621     As usual, you should not trust our example, and you should strive
 622     to double-check that your instantiation matches your target platform.
 623
 624     .. tabs::
 625
 626        .. example-tab:: examples/platforms/energy_platform.xml
 627
 628   - **Consumption due to the CPU:**
 629     This example shows how to retrieve the amount of energy consumed
 630     by the CPU during computations, and the impact of the pstate.
 631
 632     .. tabs::
 633
 634        .. example-tab:: examples/s4u/energy-exec/s4u-energy-exec.cpp
 635
 636        .. example-tab:: examples/c/energy-exec/energy-exec.c
 637
 638   - **Consumption due to the network:**
 639     This example shows how to retrieve and display the energy consumed
 640     by the network during communications.
 641
 642     .. tabs::
 643
 644        .. example-tab:: examples/s4u/energy-link/s4u-energy-link.cpp
 645
 646   - **Modeling the shutdown and boot of hosts:**
 647     Simple example of model of model for the energy consumption during
 648     the host boot and shutdown periods.
 649
 650     .. tabs::
 651
 652        .. example-tab:: examples/s4u/energy-boot/platform_boot.xml
 653
 654        .. example-tab:: examples/s4u/energy-boot/s4u-energy-boot.cpp
 655
 656 =======================
 657 Tracing and Visualizing
 658 =======================
 659
 660 Tracing can be activated by various configuration options which
 661 are illustrated in these example. See also the
 662 :ref:`full list of options related to tracing <tracing_tracing_options>`.
 663
 664 It is interesting to run the process-create example with the following
 665 options to see the task executions:
 666
 667   - **Platform Tracing:**
 668     This program is a toy example just loading the platform, so that
 669     you can play with the platform visualization. Recommanded options:
 670     ``--cfg=tracing:yes --cfg=tracing/categorized:yes``
 671
 672     .. tabs::
 673
 674        .. example-tab:: examples/s4u/trace-platform/s4u-trace-platform.cpp
 675
 676 ========================
 677 Larger SimGrid Examplars
 678 ========================
 679
 680 This section contains application examples that are somewhat larger
 681 than the previous examples.
 682
 683   - **Ping Pong:**
 684     This simple example just sends one message back and forth.
 685     The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
 686     the simulators (as detailed in Section :ref:`options`).
 687
 688     .. tabs::
 689
 690        .. example-tab:: examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 691
 692        .. example-tab:: examples/c/app-pingpong/app-pingpong.c
 693
 694   - **Token ring:**
 695     Shows how to implement a classical communication pattern, where a
 696     token is exchanged along a ring to reach every participant.
 697
 698     .. tabs::
 699
 700        .. example-tab:: examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 701
 702        .. example-tab:: examples/c/app-token-ring/app-token-ring.c
 703
 704   - **Master Workers:**
 705     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
 706     processes.
 707
 708     .. tabs::
 709
 710        .. group-tab:: C++
 711
 712           This example comes in two equivalent variants, one where the actors
 713           are specified as simple functions (which is easier to understand for
 714           newcomers) and one where the actors are specified as classes (which is
 715           more powerful for the users wanting to build their own projects upon
 716           the example).
 717
 718           .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-class.cpp
 719              :language: cpp
 720
 721           .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp
 722              :language: cpp
 723
 724 Data diffusion
 725 --------------
 726
 727   - **Bit Torrent:**
 728     Classical protocol for Peer-to-Peer data diffusion.
 729
 730     .. tabs::
 731
 732        .. group-tab:: C++
 733
 734           .. showfile:: examples/s4u/app-bittorrent/s4u-bittorrent.cpp
 735              :language: cpp
 736
 737           .. showfile:: examples/s4u/app-bittorrent/s4u-peer.cpp
 738              :language: cpp
 739
 740           .. showfile:: examples/s4u/app-bittorrent/s4u-tracker.cpp
 741              :language: cpp
 742
 743   - **Chained Send:**
 744     Data broadcast over a ring of processes.
 745
 746     .. tabs::
 747
 748        .. example-tab:: examples/s4u/app-chainsend/s4u-app-chainsend.cpp
 749
 750        .. group-tab:: C
 751
 752           .. showfile:: examples/c/app-chainsend/chainsend.c
 753              :language: c
 754
 755           .. showfile:: examples/c/app-chainsend/broadcaster.c
 756              :language: c
 757
 758           .. showfile:: examples/c/app-chainsend/peer.c
 759              :language: c
 760
 761 Distributed Hash Tables (DHT)
 762 -----------------------------
 763
 764   - **Chord Protocol**
 765     One of the most famous DHT protocol.
 766
 767     .. tabs::
 768
 769        .. group-tab:: C++
 770
 771           .. showfile:: examples/s4u/dht-chord/s4u-dht-chord.cpp
 772              :language: cpp
 773
 774           .. showfile:: examples/s4u/dht-chord/s4u-dht-chord-node.cpp
 775              :language: cpp
 776
 777   - **Kademlia**
 778     Another well-known DHT protocol.
 779
 780     .. tabs::
 781
 782        .. group-tab:: C++
 783
 784           .. showfile:: examples/s4u/dht-kademlia/s4u-dht-kademlia.cpp
 785              :language: cpp
 786
 787           .. showfile:: examples/s4u/dht-kademlia/routing_table.cpp
 788              :language: cpp
 789
 790           .. showfile:: examples/s4u/dht-kademlia/answer.cpp
 791              :language: cpp
 792
 793           .. showfile:: examples/s4u/dht-kademlia/node.cpp
 794              :language: cpp
 795
 796 .. _s4u_ex_clouds:
 797
 798 Simulating Clouds
 799 -----------------
 800
 801   - **Cloud basics**
 802     This example starts some computations both on PMs and VMs, and
 803     migrates some VMs around.
 804
 805     .. tabs::
 806
 807        .. example-tab:: examples/s4u/cloud-simple/s4u-cloud-simple.cpp
 808
 809        .. example-tab:: examples/c/cloud-simple/cloud-simple.c
 810
 811   - **Migrating VMs**
 812     This example shows how to migrate VMs between PMs.
 813
 814     .. tabs::
 815
 816        .. example-tab:: examples/s4u/cloud-migration/s4u-cloud-migration.cpp
 817
 818        .. example-tab:: examples/c/cloud-migration/cloud-migration.c
 819
 820 =======================
 821 Model-Checking Examples
 822 =======================
 823
 824 The model-checker can be used to exhaustively search for issues in the
 825 tested application. It must be activated at compile time, but this
 826 mode is rather experimental in SimGrid (as of v3.22). You should not
 827 enable it unless you really want to formally verify your applications:
 828 SimGrid is slower and maybe less robust when MC is enabled.
 829
 830   - **Failing assert**
 831     In this example, two actors send some data to a central server,
 832     which asserts that the messages are always received in the same order.
 833     This is obviously wrong, and the model-checker correctly finds a
 834     counter-example to that assertion.
 835
 836     .. tabs::
 837
 838        .. example-tab:: examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp
 839
 840 .. |br| raw:: html
 841
 842    <br />
 843
 844 .. |cpp| image:: /img/lang_cpp.png
 845    :align: middle
 846    :width: 12
 847
 848 .. |py| image:: /img/lang_python.png
 849    :align: middle
 850    :width: 12