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 .. _s4u_examples:
   7
   8 Examples
   9 ********
  10
  11 SimGrid comes with an extensive set of examples, documented on this
  12 page. Most of them only demonstrate one single feature, with some
  13 larger exemplars listed below.
  14
  15 The C++ examples can be found under examples/cpp while python examples
  16 are in examples/python. Each such directory contains the source code (also listed
  17 from this page), and the so-called tesh file containing how to call
  18 the binary obtained by compiling this example and also the expected
  19 output. Tesh files are used to turn each of our examples into an
  20 integration test. Some examples also contain other files, on need.
  21
  22 A good way to bootstrap your own project is to copy and combine some
  23 of the provided examples to constitute the skeleton of what you plan
  24 to simulate.
  25
  26 .. _s4u_ex_actors:
  27
  28 ===========================
  29 Actors: the Active Entities
  30 ===========================
  31
  32 Starting and Stopping Actors
  33 ----------------------------
  34
  35 .. _s4u_ex_actors_create:
  36
  37 Creating actors
  38 ^^^^^^^^^^^^^^^
  39
  40 Most actors are started from the deployment XML file because this
  41 is a :ref:`better scientific habit <howto_science>`, but you can
  42 also create them directly from your code.
  43
  44 .. tabs::
  45
  46    .. example-tab:: examples/cpp/actor-create/s4u-actor-create.cpp
  47
  48       You create actors either:
  49
  50       - Directly with :cpp:func:`simgrid::s4u::Actor::create`
  51       - From XML with :cpp:func:`simgrid::s4u::Engine::register_actor` (if your actor is a class)
  52         or :cpp:func:`simgrid::s4u::Engine::register_function` (if your actor is a function)
  53         and then :cpp:func:`simgrid::s4u::Engine::load_deployment`
  54
  55    .. example-tab:: examples/python/actor-create/actor-create.py
  56
  57       You create actors either:
  58
  59       - Directly with :py:func:`simgrid.Actor.create()`
  60       - From XML with :py:func:`simgrid.Engine.register_actor()` and then :py:func:`simgrid.Engine.load_deployment()`
  61
  62    .. example-tab:: examples/c/actor-create/actor-create.c
  63
  64       You create actors either:
  65
  66       - Directly with :cpp:func:`sg_actor_create` followed by :cpp:func:`sg_actor_start`.
  67       - From XML with :cpp:func:`simgrid_register_function` and then :cpp:func:`simgrid_load_deployment`.
  68
  69    .. example-tab:: examples/python/actor-create/actor-create_d.xml
  70
  71       The following file is used in both C++ and Python.
  72
  73 Reacting to actors' end
  74 ^^^^^^^^^^^^^^^^^^^^^^^
  75
  76 You can attach callbacks to the end of actors. There are several ways of doing so, depending on whether you want to
  77 attach your callback to a given actor and on how you define the end of a
  78 given actor. User code probably wants to react to the termination of an actor
  79 while some plugins want to react to the destruction (memory collection) of
  80 actors.
  81
  82 .. tabs::
  83
  84    .. example-tab:: examples/cpp/actor-exiting/s4u-actor-exiting.cpp
  85
  86       This example shows how to attach a callback to:
  87
  88       - the end of a specific actor: :cpp:func:`simgrid::s4u::Actor::on_exit()`
  89       - the end of any actor: :cpp:func:`simgrid::s4u::Actor::on_termination_cb`
  90       - the destruction of any actor: :cpp:func:`simgrid::s4u::Actor::on_destruction_cb`
  91
  92    .. example-tab:: examples/c/actor-exiting/actor-exiting.c
  93
  94       This example shows how to attach a callback to the end of a specific actor with
  95       :cpp:func:`sg_actor_on_exit()`.
  96
  97 Killing actors
  98 ^^^^^^^^^^^^^^
  99
 100 Actors can forcefully stop other actors.
 101
 102 .. tabs::
 103
 104    .. example-tab:: examples/cpp/actor-kill/s4u-actor-kill.cpp
 105
 106       See also :cpp:func:`void simgrid::s4u::Actor::kill(void)`, :cpp:func:`void simgrid::s4u::Actor::kill_all()`,
 107       :cpp:func:`simgrid::s4u::this_actor::exit`, :cpp:func:`simgrid::s4u::Actor::on_exit`.
 108
 109    .. example-tab:: examples/python/actor-kill/actor-kill.py
 110
 111       See also :py:func:`simgrid.Actor.kill`, :py:func:`simgrid.Actor.kill_all`, :py:func:`simgrid.this_actor.exit`,
 112       :py:func:`simgrid.this_actor.on_exit`.
 113
 114    .. example-tab:: examples/c/actor-kill/actor-kill.c
 115
 116       See also :cpp:func:`sg_actor_kill`, :cpp:func:`sg_actor_kill_all`, :cpp:func:`sg_actor_exit`, :cpp:func:`sg_actor_on_exit`.
 117
 118 Actors' life cycle from XML_reference
 119 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 120
 121 You can specify a start time and a kill time in the deployment file.
 122
 123 .. tabs::
 124
 125    .. example-tab:: examples/cpp/actor-lifetime/s4u-actor-lifetime.cpp
 126
 127       This file is not really interesting: the important matter is in the XML file.
 128
 129    .. example-tab:: examples/cpp/actor-lifetime/s4u-actor-lifetime_d.xml
 130
 131       This demonstrates the ``start_time`` and ``kill_time`` attribute of the :ref:`pf_tag_actor` tag.
 132
 133    .. example-tab:: examples/python/actor-lifetime/actor-lifetime.py
 134
 135       This file is not really interesting: the important matter is in the XML file.
 136
 137    .. example-tab:: examples/c/actor-lifetime/actor-lifetime.c
 138
 139       This file is not really interesting: the important matter is in the XML file.
 140
 141 Daemon actors
 142 ^^^^^^^^^^^^^
 143
 144 Some actors may be intended to simulate daemons that run in the background.
 145 This example shows how to transform a regular
 146 actor into a daemon that will be automatically killed once the simulation is over.
 147
 148 .. tabs::
 149
 150    .. example-tab:: examples/cpp/actor-daemon/s4u-actor-daemon.cpp
 151
 152       See also :cpp:func:`simgrid::s4u::Actor::daemonize()` and :cpp:func:`simgrid::s4u::Actor::is_daemon()`.
 153
 154    .. example-tab:: examples/python/actor-daemon/actor-daemon.py
 155
 156       See also :py:func:`simgrid.Actor.daemonize()` and :py:func:`simgrid.Actor.is_daemon()`.
 157
 158    .. example-tab:: examples/c/actor-daemon/actor-daemon.c
 159
 160       See also :cpp:func:`sg_actor_daemonize` and :cpp:func:`sg_actor_is_daemon`.
 161
 162 Specifying the stack size
 163 ^^^^^^^^^^^^^^^^^^^^^^^^^
 164
 165 The stack size can be specified by default on the command line,
 166 globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config`,
 167 or for a specific actor using :cpp:func:`simgrid::s4u::Actor::set_stacksize` before its start.
 168
 169 .. tabs::
 170
 171    .. example-tab:: examples/cpp/actor-stacksize/s4u-actor-stacksize.cpp
 172
 173    .. example-tab:: examples/c/actor-stacksize/actor-stacksize.c
 174
 175 Inter-Actors Interactions
 176 -------------------------
 177
 178 See also the examples on :ref:`inter-actors communications
 179 <s4u_ex_communication>` and the ones on :ref:`classical
 180 synchronization objects <s4u_ex_IPC>`.
 181
 182 Suspending/resuming Actors
 183 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 184
 185 Actors can be suspended and resumed during their executions.
 186
 187 .. tabs::
 188
 189    .. example-tab:: examples/cpp/actor-suspend/s4u-actor-suspend.cpp
 190
 191       See also :cpp:func:`simgrid::s4u::this_actor::suspend()`,
 192       :cpp:func:`simgrid::s4u::Actor::suspend()`, :cpp:func:`simgrid::s4u::Actor::resume()`, and
 193       :cpp:func:`simgrid::s4u::Actor::is_suspended()`.
 194
 195    .. example-tab:: examples/python/actor-suspend/actor-suspend.py
 196
 197       See also :py:func:`simgrid.this_actor.suspend()`,
 198       :py:func:`simgrid.Actor.suspend()`, :py:func:`simgrid.Actor.resume()`, and
 199       :py:func:`simgrid.Actor.is_suspended()`.
 200
 201    .. example-tab:: examples/c/actor-suspend/actor-suspend.c
 202
 203       See also :cpp:func:`sg_actor_suspend()`, :cpp:func:`sg_actor_resume()`, and
 204       :cpp:func:`sg_actor_is_suspended()`.
 205
 206 Migrating Actors
 207 ^^^^^^^^^^^^^^^^
 208
 209 Actors can move or be moved from a host to another very easily. It amounts to setting them on a new host.
 210
 211 .. tabs::
 212
 213    .. example-tab:: examples/cpp/actor-migrate/s4u-actor-migrate.cpp
 214
 215       See also :cpp:func:`simgrid::s4u::this_actor::set_host()` and :cpp:func:`simgrid::s4u::Actor::set_host()`.
 216
 217    .. example-tab:: examples/python/actor-migrate/actor-migrate.py
 218
 219       See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.host`.
 220
 221    .. example-tab:: examples/c/actor-migrate/actor-migrate.c
 222
 223       See also :cpp:func:`sg_actor_set_host()`.
 224
 225 Waiting for the termination of an actor (joining on it)
 226 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 227
 228 You can block the current actor until the end of another actor.
 229
 230 .. tabs::
 231
 232    .. example-tab:: examples/cpp/actor-join/s4u-actor-join.cpp
 233
 234       See also :cpp:func:`simgrid::s4u::Actor::join()`.
 235
 236    .. example-tab:: examples/python/actor-join/actor-join.py
 237
 238       See also :py:func:`simgrid.Actor.join()`.
 239
 240    .. example-tab:: examples/c/actor-join/actor-join.c
 241
 242       See also :cpp:func:`sg_actor_join`.
 243
 244 Yielding to other actors
 245 ^^^^^^^^^^^^^^^^^^^^^^^^
 246
 247 The ```yield()``` function interrupts the execution of the current
 248 actor, leaving a chance to the other actors that are ready to run
 249 at this timestamp.
 250
 251 .. tabs::
 252
 253    .. example-tab:: examples/cpp/actor-yield/s4u-actor-yield.cpp
 254
 255       See also :cpp:func:`simgrid::s4u::this_actor::yield()`.
 256
 257    .. example-tab:: examples/python/actor-yield/actor-yield.py
 258
 259       See also :py:func:`simgrid.this_actor.yield_()`.
 260
 261    .. example-tab:: examples/c/actor-yield/actor-yield.c
 262
 263       See also :cpp:func:`sg_actor_yield()`.
 264
 265 Traces Replay as a Workload
 266 ---------------------------
 267
 268 This section details how to run trace-driven simulations. It is very
 269 handy when you want to test an algorithm or protocol that only reacts
 270 to external events. For example, many P2P protocols react to user
 271 requests, but do nothing if there is no such event.
 272
 273 In such situations, you should write your protocol in C++, and separate
 274 the workload that you want to play onto your protocol in a separate
 275 text file. Declare a function handling each type of the events in your
 276 trace, register them using :cpp:func:`xbt_replay_action_register()` in
 277 your main, and then run the simulation.
 278
 279 Then, you can either have one trace file containing all your events,
 280 or a file per simulated process: the former may be easier to work
 281 with, but the second is more efficient on very large traces. Check
 282 also the tesh files in the example directories for details.
 283
 284 Communication replay
 285 ^^^^^^^^^^^^^^^^^^^^
 286
 287 Presents a set of event handlers reproducing classical communication primitives (asynchronous send/receive at the moment).
 288
 289 .. tabs::
 290
 291    .. example-tab:: examples/cpp/replay-comm/s4u-replay-comm.cpp
 292
 293 I/O replay
 294 ^^^^^^^^^^
 295
 296 Presents a set of event handlers reproducing classical I/O primitives (open, read, close).
 297
 298 .. tabs::
 299
 300    .. example-tab:: examples/cpp/replay-io/s4u-replay-io.cpp
 301
 302 ==========================
 303 Activities: what Actors do
 304 ==========================
 305
 306 .. _s4u_ex_communication:
 307
 308 Communications on the Network
 309 -----------------------------
 310
 311 Basic communications
 312 ^^^^^^^^^^^^^^^^^^^^
 313
 314 This simple example just sends one message back and forth.
 315 The tesh file laying in the directory shows how to start the simulator binary, highlighting how to pass options to
 316 the simulators (as detailed in Section :ref:`options`).
 317
 318 .. tabs::
 319
 320    .. example-tab:: examples/cpp/comm-pingpong/s4u-comm-pingpong.cpp
 321
 322    .. example-tab:: examples/c/comm-pingpong/comm-pingpong.c
 323
 324
 325 Basic asynchronous communications
 326 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 327
 328 Illustrates how to have non-blocking communications, that are communications running in the background leaving the process
 329 free to do something else during their completion.
 330
 331 .. tabs::
 332
 333    .. example-tab:: examples/cpp/comm-wait/s4u-comm-wait.cpp
 334
 335       See also :cpp:func:`simgrid::s4u::Mailbox::put_async()` and :cpp:func:`simgrid::s4u::Comm::wait()`.
 336
 337    .. example-tab:: examples/python/comm-wait/comm-wait.py
 338
 339       See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`.
 340
 341    .. example-tab:: examples/c/comm-wait/comm-wait.c
 342
 343       See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm_wait()`.
 344
 345 Waiting for communications with timeouts
 346 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 347
 348 This example is very similar to the previous one, simply adding how to declare timeouts when waiting on asynchronous communication.
 349
 350 .. tabs::
 351
 352    .. example-tab:: examples/cpp/comm-waituntil/s4u-comm-waituntil.cpp
 353
 354       See also :cpp:func:`simgrid::s4u::Activity::wait_until()` and :cpp:func:`simgrid::s4u::Comm::wait_for()`.
 355
 356 Suspending communications
 357 ^^^^^^^^^^^^^^^^^^^^^^^^^
 358
 359 The ``suspend()`` and ``resume()`` functions block the progression of a given communication for a while and then unblock it.
 360 ``is_suspended()`` returns whether that activity is currently blocked or not.
 361
 362 .. tabs::
 363
 364    .. example-tab:: examples/cpp/comm-suspend/s4u-comm-suspend.cpp
 365
 366       See also :cpp:func:`simgrid::s4u::Activity::suspend()`
 367       :cpp:func:`simgrid::s4u::Activity::resume()` and
 368       :cpp:func:`simgrid::s4u::Activity::is_suspended()`.
 369
 370 Waiting for all communications in a set
 371 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 372
 373 The ``wait_all()`` function is useful when you want to block until all activities in a given set have been completed.
 374
 375 .. tabs::
 376
 377    .. example-tab:: examples/cpp/comm-waitall/s4u-comm-waitall.cpp
 378
 379       See also :cpp:func:`simgrid::s4u::Comm::wait_all()`.
 380
 381    .. example-tab:: examples/python/comm-waitall/comm-waitall.py
 382
 383       See also :py:func:`simgrid.Comm.wait_all()`.
 384
 385    .. example-tab:: examples/c/comm-waitall/comm-waitall.c
 386
 387       See also :cpp:func:`sg_comm_wait_all()`.
 388
 389 Waiting for the first completed communication in a set
 390 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 391
 392 The ``wait_any()`` blocks until one activity of the set completes, no matter which terminates first.
 393
 394 .. tabs::
 395
 396    .. example-tab:: examples/cpp/comm-waitany/s4u-comm-waitany.cpp
 397
 398       See also :cpp:func:`simgrid::s4u::Comm::wait_any()`.
 399
 400    .. example-tab:: examples/python/comm-waitany/comm-waitany.py
 401
 402       See also :py:func:`simgrid.Comm.wait_any()`.
 403
 404    .. example-tab:: examples/c/comm-waitany/comm-waitany.c
 405
 406       See also :cpp:func:`sg_comm_wait_any`.
 407
 408 Testing whether at least one communication completed
 409 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 410
 411 The ``test_any()`` returns whether at least one activity of the set has completed, or -1.
 412
 413 .. tabs::
 414
 415    .. example-tab:: examples/cpp/comm-testany/s4u-comm-testany.cpp
 416
 417       See also :cpp:func:`simgrid::s4u::Comm::test_any()`.
 418
 419
 420 .. _s4u_ex_execution:
 421
 422 Executions on the CPU
 423 ---------------------
 424
 425 Basic execution
 426 ^^^^^^^^^^^^^^^
 427
 428 The computations done in your program are not reported to the
 429 simulated world unless you explicitly request the simulator to pause
 430 the actor until a given amount of flops gets computed on its simulated
 431 host. Some executions can be given a higher priority so that they
 432 get more resources.
 433
 434 .. tabs::
 435
 436    .. example-tab:: examples/cpp/exec-basic/s4u-exec-basic.cpp
 437
 438       See also :cpp:func:`void simgrid::s4u::this_actor::execute(double)`
 439       and :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`.
 440
 441    .. example-tab:: examples/python/exec-basic/exec-basic.py
 442
 443       See also :py:func:`simgrid.this_actor.execute()`.
 444
 445    .. example-tab:: examples/c/exec-basic/exec-basic.c
 446
 447       See also :cpp:func:`void sg_actor_execute(double)`
 448       and :cpp:func:`void sg_actor_execute_with_priority(double, double)`.
 449
 450 Asynchronous execution
 451 ^^^^^^^^^^^^^^^^^^^^^^
 452
 453 You can start asynchronous executions, just like you would fire background threads.
 454
 455 .. tabs::
 456
 457    .. example-tab:: examples/cpp/exec-async/s4u-exec-async.cpp
 458
 459       See also :cpp:func:`simgrid::s4u::this_actor::exec_init()`,
 460       :cpp:func:`simgrid::s4u::Activity::start()`,
 461       :cpp:func:`simgrid::s4u::Activity::wait()`,
 462       :cpp:func:`simgrid::s4u::Activity::get_remaining()`,
 463       :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`,
 464       :cpp:func:`simgrid::s4u::this_actor::exec_async()` and
 465       :cpp:func:`simgrid::s4u::Activity::cancel()`.
 466
 467    .. example-tab:: examples/python/exec-async/exec-async.py
 468
 469       See also :py:func:`simgrid.this_actor.exec_init()`,
 470       :py:func:`simgrid.Activity.start()`,
 471       :py:func:`simgrid.Activity.wait()`,
 472       :py:func:`simgrid.Activity.get_remaining()`,
 473       :py:func:`simgrid.Exec.get_remaining_ratio()`,
 474       :py:func:`simgrid.this_actor.exec_async()` and
 475       :py:func:`simgrid.Activity.cancel()`.
 476
 477    .. example-tab:: examples/c/exec-async/exec-async.c
 478
 479       See also :cpp:func:`sg_actor_exec_init()`,
 480       :cpp:func:`sg_exec_start()`,
 481       :cpp:func:`sg_exec_wait()`,
 482       :cpp:func:`sg_exec_get_remaining()`,
 483       :cpp:func:`sg_exec_get_remaining_ratio()`,
 484       :cpp:func:`sg_actor_exec_async()` and
 485       :cpp:func:`sg_exec_cancel()`,
 486
 487 Remote execution
 488 ^^^^^^^^^^^^^^^^
 489
 490 You can start executions on remote hosts, or even change the host on which they occur during their execution.
 491
 492 .. tabs::
 493
 494    .. example-tab:: examples/cpp/exec-remote/s4u-exec-remote.cpp
 495
 496       See also :cpp:func:`simgrid::s4u::Exec::set_host()`.
 497
 498    .. example-tab:: examples/python/exec-remote/exec-remote.py
 499
 500       See also :py:func:`simgrid.Exec.host`.
 501
 502    .. example-tab:: examples/c/exec-remote/exec-remote.c
 503
 504       See also :cpp:func:`sg_exec_set_host()`.
 505
 506 Parallel executions
 507 ^^^^^^^^^^^^^^^^^^^
 508
 509 These objects are convenient abstractions of parallel
 510 computational kernels that span over several machines, such as a
 511 PDGEM and the other ScaLAPACK routines. Note that this only works
 512 with the "ptask_L07" host model (``--cfg=host/model:ptask_L07``).
 513
 514 This example demonstrates several kinds of parallel tasks: regular
 515 ones, communication-only (without computation), computation-only
 516 (without communication), synchronization-only (neither
 517 communication nor computation). It also shows how to reconfigure a
 518 task after its start, to change the number of hosts it runs onto.
 519 This allows simulating malleable tasks.
 520
 521 .. tabs::
 522
 523    .. example-tab:: examples/cpp/exec-ptask/s4u-exec-ptask.cpp
 524
 525       See also :cpp:func:`simgrid::s4u::this_actor::parallel_execute()`.
 526
 527 DVFS and pstates
 528 ^^^^^^^^^^^^^^^^
 529
 530 This example shows how to define a set of pstates in the XML. The current pstate
 531 of a host can then be accessed and changed from the program.
 532
 533 .. tabs::
 534
 535    .. example-tab:: examples/cpp/exec-dvfs/s4u-exec-dvfs.cpp
 536
 537       See also :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`.
 538
 539    .. example-tab:: examples/c/exec-dvfs/exec-dvfs.c
 540
 541       See also :cpp:func:`sg_host_get_pstate_speed` and :cpp:func:`sg_host_set_pstate`.
 542
 543    .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py
 544
 545       See also :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`.
 546
 547    .. example-tab:: examples/platforms/energy_platform.xml
 548
 549 .. _s4u_ex_disk_io:
 550
 551 I/O on Disks and Files
 552 ----------------------
 553
 554 SimGrid provides two levels of abstraction to interact with the
 555 simulated disks. At the simplest level, you simply create read and
 556 write actions on the disk resources.
 557
 558 Access to raw disk devices
 559 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 560
 561 This example illustrates how to simply read and write data on a simulated disk resource.
 562
 563 .. tabs::
 564
 565    .. example-tab:: examples/cpp/io-disk-raw/s4u-io-disk-raw.cpp
 566
 567    .. example-tab:: examples/c/io-disk-raw/io-disk-raw.c
 568
 569    .. example-tab:: examples/platforms/hosts_with_disks.xml
 570
 571       This shows how to declare disks in XML.
 572
 573 Filesystem plugin
 574 ^^^^^^^^^^^^^^^^^
 575
 576 The FileSystem plugin provides a more detailed view, with the
 577 classical operations over files: open, move, unlink, and of course,
 578 read and write. The file and disk sizes are also dealt with and can
 579 result in short reads and short writes, as in reality.
 580
 581   - **File Management:**
 582     This example illustrates the use of operations on files
 583     (read, write, seek, tell, unlink, etc).
 584
 585     .. tabs::
 586
 587        .. example-tab:: examples/cpp/io-file-system/s4u-io-file-system.cpp
 588
 589   - **Remote I/O:**
 590     I/O operations on files can also be done remotely,
 591     i.e. when the accessed disk is not mounted on the caller's host.
 592
 593     .. tabs::
 594
 595        .. example-tab:: examples/cpp/io-file-remote/s4u-io-file-remote.cpp
 596
 597        .. example-tab:: examples/c/io-file-remote/io-file-remote.c
 598
 599 .. _s4u_ex_IPC:
 600
 601 Classical synchronization objects
 602 ---------------------------------
 603
 604 Barrier
 605 ^^^^^^^
 606
 607 Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
 608
 609 .. tabs::
 610
 611    .. example-tab:: examples/cpp/synchro-barrier/s4u-synchro-barrier.cpp
 612
 613 Condition variable: basic usage
 614 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 615
 616 Shows how to use :cpp:type:`simgrid::s4u::ConditionVariable` synchronization objects.
 617
 618 .. tabs::
 619
 620    .. example-tab:: examples/cpp/synchro-condition-variable/s4u-synchro-condition-variable.cpp
 621
 622 Condition variable: timeouts
 623 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 624
 625 Shows how to specify timeouts when blocking on condition variables.
 626
 627 .. tabs::
 628
 629    .. example-tab:: examples/cpp/synchro-condition-variable-waituntil/s4u-synchro-condition-variable-waituntil.cpp
 630
 631 Mutex
 632 ^^^^^
 633
 634 Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
 635
 636 .. tabs::
 637
 638    .. example-tab:: examples/cpp/synchro-mutex/s4u-synchro-mutex.cpp
 639
 640 Semaphore
 641 ^^^^^^^^^
 642
 643 Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
 644
 645 .. tabs::
 646
 647    .. example-tab:: examples/cpp/synchro-semaphore/s4u-synchro-semaphore.cpp
 648
 649    .. example-tab:: examples/c/synchro-semaphore/synchro-semaphore.c
 650
 651 =============================
 652 Interacting with the Platform
 653 =============================
 654
 655 User-defined properties
 656 -----------------------
 657
 658 You can attach arbitrary information to most platform elements from the XML file, and then interact with these values from your
 659 program. Note that the changes are not written permanently on disk, in the XML file nor anywhere else. They only last until the end of
 660 your simulation.
 661
 662 .. tabs::
 663
 664    .. example-tab:: examples/cpp/platform-properties/s4u-platform-properties.cpp
 665
 666       - :cpp:func:`simgrid::s4u::Actor::get_property()` and :cpp:func:`simgrid::s4u::Actor::set_property()`
 667       - :cpp:func:`simgrid::s4u::Host::get_property()` and :cpp:func:`simgrid::s4u::Host::set_property()`
 668       - :cpp:func:`simgrid::s4u::Link::get_property()` and :cpp:func:`simgrid::s4u::Link::set_property()`
 669       - :cpp:func:`simgrid::s4u::NetZone::get_property()` and :cpp:func:`simgrid::s4u::NetZone::set_property()`
 670
 671    .. example-tab:: examples/c/platform-properties/platform-properties.c
 672
 673       - :cpp:func:`sg_actor_get_property_value()`
 674       - :cpp:func:`sg_host_get_property_value()` and :cpp:func:sg_host_set_property_value()`
 675       - :cpp:func:`sg_zone_get_property_value()` and :cpp:func:`sg_zone_set_property_value()`
 676
 677    .. group-tab:: XML
 678
 679       **Platform file:**
 680
 681       .. showfile:: examples/platforms/prop.xml
 682          :language: xml
 683
 684 Element filtering
 685 -----------------
 686
 687 Retrieving the netzones matching given criteria
 688 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 689
 690 Shows how to filter the cluster netzones.
 691
 692 .. tabs::
 693
 694    .. example-tab:: examples/cpp/routing-get-clusters/s4u-routing-get-clusters.cpp
 695
 696 Retrieving the list of hosts matching given criteria
 697 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 698
 699 Shows how to filter the actors that match given criteria.
 700
 701 .. tabs::
 702
 703    .. example-tab:: examples/cpp/engine-filtering/s4u-engine-filtering.cpp
 704
 705 Profiles
 706 --------
 707
 708 Specifying state profiles
 709 ^^^^^^^^^^^^^^^^^^^^^^^^^
 710
 711 Shows how to specify when the resources must be turned off and on again, and how to react to such
 712 failures in your code. See also :ref:`howto_churn`.
 713
 714 .. tabs::
 715
 716    .. example-tab:: examples/cpp/platform-failures/s4u-platform-failures.cpp
 717
 718    .. example-tab:: examples/c/platform-failures/platform-failures.c
 719
 720    .. group-tab:: XML
 721
 722       .. showfile:: examples/platforms/small_platform_failures.xml
 723          :language: xml
 724
 725       .. showfile:: examples/platforms/profiles/jupiter_state.profile
 726
 727       .. showfile:: examples/platforms/profiles/fafard_state.profile
 728
 729 Specifying speed profiles
 730 ^^^^^^^^^^^^^^^^^^^^^^^^^
 731
 732 Shows how to specify an external load to resources, variating their peak speed over time.
 733
 734    .. tabs::
 735
 736       .. example-tab:: examples/cpp/platform-profile/s4u-platform-profile.cpp
 737
 738       .. example-tab:: examples/python/platform-profile/platform-profile.py
 739
 740       .. group-tab:: XML
 741
 742          .. showfile:: examples/platforms/small_platform_profile.xml
 743             :language: xml
 744
 745          .. showfile:: examples/platforms/profiles/jupiter_speed.profile
 746
 747          .. showfile:: examples/platforms/profiles/link1_bandwidth.profile
 748
 749          .. showfile:: examples/platforms/profiles/link1_latency.profile
 750
 751 =================
 752 Energy Simulation
 753 =================
 754
 755 Setup
 756 -----
 757
 758 Describing the energy profiles in the platform
 759 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 760
 761 The first platform file contains the energy profile of each link and host for a wired network, which is necessary to get energy consumption
 762 predictions. The second platform file is the equivalent for a wireless network. As usual, you should not trust our example, and you should
 763 strive to double-check that your instantiation matches your target platform.
 764
 765 .. tabs::
 766
 767    .. group-tab:: XML
 768
 769 .. showfile:: examples/platforms/energy_platform.xml
 770    :language: xml
 771
 772 .. showfile:: examples/platforms/wifi_energy.xml
 773    :language: xml
 774
 775 Usage
 776 -----
 777
 778 CPU energy consumption
 779 ^^^^^^^^^^^^^^^^^^^^^^
 780
 781 This example shows how to retrieve the amount of energy consumed by the CPU during computations, and the impact of the pstate.
 782
 783 .. tabs::
 784
 785    .. example-tab:: examples/cpp/energy-exec/s4u-energy-exec.cpp
 786
 787    .. example-tab:: examples/c/energy-exec/energy-exec.c
 788
 789 Virtual machines consumption
 790 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 791
 792 This example is very similar to the previous one, adding VMs to the picture.
 793
 794 .. tabs::
 795
 796    .. example-tab:: examples/cpp/energy-vm/s4u-energy-vm.cpp
 797
 798    .. example-tab:: examples/c/energy-vm/energy-vm.c
 799
 800 Wired network energy consumption
 801 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 802
 803 This example shows how to retrieve and display the energy consumed by the wired network during communications.
 804
 805 .. tabs::
 806
 807    .. example-tab:: examples/cpp/energy-link/s4u-energy-link.cpp
 808
 809 WiFi network energy consumption
 810 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 811
 812 This example shows how to retrieve and display the energy consumed by the wireless network during communications.
 813
 814 .. tabs::
 815
 816    .. example-tab:: examples/cpp/energy-wifi/s4u-energy-wifi.cpp
 817
 818 Modeling the shutdown and boot of hosts
 819 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 820
 821 Simple example of a model for the energy consumption during the host boot and shutdown periods.
 822
 823 .. tabs::
 824
 825    .. example-tab:: examples/platforms/energy_boot.xml
 826
 827    .. example-tab:: examples/cpp/energy-boot/s4u-energy-boot.cpp
 828
 829 =======================
 830 Tracing and Visualizing
 831 =======================
 832
 833 Tracing can be activated by various configuration options which are illustrated in these examples. See also the
 834 :ref:`full list of options related to tracing <tracing_tracing_options>`.
 835 The following introduces  some option sets of interest that you may want to pass to your simulators.
 836
 837 .. todo::
 838    These tracing examples should be integrated in the examples to not duplicate the C++ files.
 839    A full command line to see the result in the right tool (vite/FrameSoc) should be given along with some screenshots.
 840
 841 Platform Tracing
 842 ----------------
 843
 844 Basic example
 845 ^^^^^^^^^^^^^
 846
 847 This program is a toy example just loading the platform so that you can play with the platform visualization. Recommended options:
 848 ``--cfg=tracing:yes --cfg=tracing/categorized:yes``
 849
 850 .. tabs::
 851
 852    .. example-tab:: examples/cpp/trace-platform/s4u-trace-platform.cpp
 853
 854 Setting Categories
 855 ^^^^^^^^^^^^^^^^^^
 856
 857 This example declares several tracing categories that are used to
 858 classify its tasks. When the program is executed, the tracing mechanism
 859 registers the resource utilization of hosts and links according to these
 860 categories. Recommended options:
 861 ``--cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes``
 862
 863 .. tabs::
 864
 865    .. example-tab:: examples/cpp/trace-categories/s4u-trace-categories.cpp
 866
 867 Master Workers tracing
 868 ^^^^^^^^^^^^^^^^^^^^^^
 869
 870 This is an augmented version of our basic master/worker example using
 871 several tracing features. It traces resource usage, sorted out in several
 872 categories; Trace marks and user variables are also used. Recommended
 873 options: ``--cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes``
 874
 875 .. tabs::
 876
 877    .. example-tab:: examples/cpp/trace-masterworkers/s4u-trace-masterworkers.cpp
 878
 879    .. example-tab:: examples/python/app-masterworkers/app-masterworkers.py
 880
 881 Process migration tracing
 882 ^^^^^^^^^^^^^^^^^^^^^^^^^
 883
 884 This version is enhanced so that the process migrations can be displayed
 885 as arrows in a Gantt-chart visualization. Recommended options to that
 886 extend: ``--cfg=tracing:yes --cfg=tracing/actor:yes``
 887
 888 .. tabs::
 889
 890    .. example-tab:: examples/cpp/trace-process-migration/s4u-trace-process-migration.cpp
 891
 892 Tracing user variables
 893 ----------------------
 894
 895 You can also attach your own variables to any resource described in the platform
 896 file. The following examples illustrate this feature.  They have to be run with
 897 the following options: ``--cfg=tracing:yes --cfg=tracing/platform:yes``
 898
 899 Attaching variables to Hosts
 900 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 901
 902 .. tabs::
 903
 904    .. example-tab:: examples/cpp/trace-host-user-variables/s4u-trace-host-user-variables.cpp
 905
 906 Attaching variables to Links
 907 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 908
 909 The tricky part is that you have to know the name of the link you want to enhance with a variable.
 910
 911 .. tabs::
 912
 913    .. example-tab:: examples/cpp/trace-link-user-variables/s4u-trace-link-user-variables.cpp
 914
 915 Attaching variables to network routes
 916 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 917
 918 It is often easier to update a given variable for all links of a given network path (identified by its source and destination hosts) instead of
 919 knowing the name of each specific link.
 920
 921 .. tabs::
 922
 923    .. example-tab::  examples/cpp/trace-route-user-variables/s4u-trace-route-user-variables.cpp
 924
 925 ========================
 926 Larger SimGrid Exemplars
 927 ========================
 928
 929 This section contains application examples that are somewhat larger than the previous examples.
 930
 931 Classical examples
 932 ------------------
 933
 934 Token ring
 935 ^^^^^^^^^^
 936
 937 Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every participant.
 938
 939 .. tabs::
 940
 941    .. example-tab:: examples/cpp/app-token-ring/s4u-app-token-ring.cpp
 942
 943    .. example-tab:: examples/c/app-token-ring/app-token-ring.c
 944
 945 Master Workers
 946 ^^^^^^^^^^^^^^
 947
 948 Another good old example, where one Master acto$ has a bunch of tasks to dispatch to a set of several Worker actors.
 949 This example is used in the :ref:`SimGrid tutorial <usecase_simalgo>`.
 950
 951 .. tabs::
 952
 953    .. group-tab:: C++
 954
 955       This example comes in two equivalent variants, one where the actors
 956       are specified as simple functions (which is easier to understand for
 957       newcomers) and one where the actors are specified as classes (which is
 958       more powerful for the users wanting to build their own projects upon
 959       the example).
 960
 961       .. showfile:: examples/cpp/app-masterworkers/s4u-app-masterworkers-class.cpp
 962          :language: cpp
 963
 964       .. showfile:: examples/cpp/app-masterworkers/s4u-app-masterworkers-fun.cpp
 965          :language: cpp
 966
 967    .. group-tab:: C
 968
 969       .. showfile:: examples/c/app-masterworker/app-masterworker.c
 970          :language: cpp
 971
 972 Data diffusion
 973 --------------
 974
 975 Bit Torrent
 976 ^^^^^^^^^^^
 977
 978 Classical protocol for Peer-to-Peer data diffusion.
 979
 980 .. tabs::
 981
 982    .. group-tab:: C++
 983
 984       .. showfile:: examples/cpp/app-bittorrent/s4u-bittorrent.cpp
 985          :language: cpp
 986
 987       .. showfile:: examples/cpp/app-bittorrent/s4u-peer.cpp
 988          :language: cpp
 989
 990       .. showfile:: examples/cpp/app-bittorrent/s4u-tracker.cpp
 991          :language: cpp
 992
 993    .. group-tab:: C
 994
 995       .. showfile:: examples/c/app-bittorrent/app-bittorrent.c
 996          :language: cpp
 997
 998       .. showfile:: examples/c/app-bittorrent/bittorrent-peer.c
 999          :language: cpp
1000
1001       .. showfile:: examples/c/app-bittorrent/tracker.c
1002          :language: cpp
1003
1004 Chained Send
1005 ^^^^^^^^^^^^
1006
1007 Data broadcast over a ring of processes.
1008
1009 .. tabs::
1010
1011    .. example-tab:: examples/cpp/app-chainsend/s4u-app-chainsend.cpp
1012
1013    .. group-tab:: C
1014
1015       .. showfile:: examples/c/app-chainsend/chainsend.c
1016          :language: c
1017
1018       .. showfile:: examples/c/app-chainsend/broadcaster.c
1019          :language: c
1020
1021       .. showfile:: examples/c/app-chainsend/peer.c
1022          :language: c
1023
1024 Distributed Hash Tables (DHT)
1025 -----------------------------
1026
1027 Chord Protocol
1028 ^^^^^^^^^^^^^^
1029
1030 One of the most famous DHT protocol.
1031
1032 .. tabs::
1033
1034    .. group-tab:: C++
1035
1036       .. showfile:: examples/cpp/dht-chord/s4u-dht-chord.cpp
1037          :language: cpp
1038
1039       .. showfile:: examples/cpp/dht-chord/s4u-dht-chord-node.cpp
1040          :language: cpp
1041
1042 Kademlia
1043 ^^^^^^^^
1044
1045 Another well-known DHT protocol.
1046
1047 .. tabs::
1048
1049    .. group-tab:: C++
1050
1051       .. showfile:: examples/cpp/dht-kademlia/s4u-dht-kademlia.cpp
1052          :language: cpp
1053
1054       .. showfile:: examples/cpp/dht-kademlia/routing_table.cpp
1055          :language: cpp
1056
1057       .. showfile:: examples/cpp/dht-kademlia/answer.cpp
1058          :language: cpp
1059
1060       .. showfile:: examples/cpp/dht-kademlia/node.cpp
1061          :language: cpp
1062
1063    .. group-tab:: C
1064
1065       .. showfile:: examples/c/dht-kademlia/dht-kademlia.c
1066          :language: cpp
1067
1068       .. showfile:: examples/c/dht-kademlia/routing_table.c
1069          :language: cpp
1070
1071       .. showfile:: examples/c/dht-kademlia/answer.c
1072          :language: cpp
1073
1074       .. showfile:: examples/c/dht-kademlia/message.c
1075          :language: cpp
1076
1077       .. showfile:: examples/c/dht-kademlia/node.c
1078          :language: cpp
1079
1080 Pastry
1081 ^^^^^^
1082
1083 Yet another well-known DHT protocol.
1084
1085 .. tabs::
1086
1087    .. example-tab:: examples/c/dht-pastry/dht-pastry.c
1088
1089 .. _s4u_ex_clouds:
1090
1091 Simulating Clouds
1092 -----------------
1093
1094 Cloud basics
1095 ^^^^^^^^^^^^
1096
1097 This example starts some computations both on PMs and VMs and migrates some VMs around.
1098
1099 .. tabs::
1100
1101    .. example-tab:: examples/cpp/cloud-simple/s4u-cloud-simple.cpp
1102
1103    .. example-tab:: examples/c/cloud-simple/cloud-simple.c
1104
1105 Migrating VMs
1106 ^^^^^^^^^^^^^
1107
1108 This example shows how to migrate VMs between PMs.
1109
1110 .. tabs::
1111
1112    .. example-tab:: examples/cpp/cloud-migration/s4u-cloud-migration.cpp
1113
1114    .. example-tab:: examples/c/cloud-migration/cloud-migration.c
1115
1116 =======================
1117 Model-Related Examples
1118 =======================
1119
1120 ns-3 as a model
1121 ---------------
1122
1123 This simple ping-pong example demonstrates how to use the bindings to the Network
1124 Simulator. The most interesting is probably not the C++ files since
1125 they are unchanged from the other simulations, but the associated files,
1126 such as the platform file to see how to declare a platform to be used
1127 with the ns-3 bindings of SimGrid and the tesh file to see how to
1128 start a simulation in these settings.
1129
1130 .. tabs::
1131
1132    .. example-tab:: examples/cpp/network-ns3/s4u-network-ns3.cpp
1133
1134    .. group-tab:: XML
1135
1136       **Platform files:**
1137
1138       .. showfile:: examples/platforms/small_platform_one_link_routes.xml
1139          :language: xml
1140
1141 WiFi links
1142 ----------
1143
1144 This demonstrates how to declare a wifi zone in your platform and
1145 how to use it in your simulation. For that, you should have a link
1146 whose sharing policy is set to `WIFI`. Such links can have more
1147 than one bandwidth value (separated by commas), corresponding to
1148 the several SNR level of your wifi link.
1149
1150 In this case, SimGrid automatically switches to validated
1151 performance models of wifi networks, where the time is shared
1152 between users instead of the bandwidth for wired links (the
1153 corresponding publication is currently being written).
1154
1155 If your wifi link provides more than one SNR level, you can switch
1156 the level of a given host using
1157 :cpp:func:`simgrid::s4u::Link::set_host_wifi_rate`. By default,
1158 the first level is used.
1159
1160 .. tabs::
1161
1162    .. example-tab:: examples/cpp/network-wifi/s4u-network-wifi.cpp
1163
1164    .. group-tab:: XML
1165
1166       **Platform files:**
1167
1168       .. showfile:: examples/platforms/wifi.xml
1169          :language: xml
1170
1171 ===============
1172 Plugin Examples
1173 ===============
1174
1175 It is possible to extend SimGrid without modifying its internals by
1176 attaching code to the existing signals and by adding extra data to the
1177 simulation objects through extensions. How to do that is not exactly
1178 documented yet, and you should look for examples in the src/plugins
1179 directory.
1180
1181 This section documents how the existing plugins can be used. Remember
1182 that you are very welcome to modify the plugins to fit your needs. It
1183 should be much easier than modifying the SimGrid kernel.
1184
1185 Monitoring the host load
1186 ------------------------
1187
1188 .. tabs::
1189
1190    .. example-tab:: examples/cpp/plugin-host-load/s4u-plugin-host-load.cpp
1191
1192    .. example-tab:: examples/c/plugin-host-load/plugin-host-load.c
1193
1194 Monitoring the link load
1195 ------------------------
1196
1197 .. tabs::
1198
1199    .. example-tab:: examples/cpp/plugin-link-load/s4u-plugin-link-load.cpp
1200
1201 =======================
1202 Model-Checking Examples
1203 =======================
1204
1205 The model-checker can be used to exhaustively search for issues in the tested application. It must be activated at compile-time, but this
1206 mode is rather experimental in SimGrid (as of v3.25). We are working on it :)
1207
1208 Failing assert
1209 --------------
1210
1211 In this example, two actors send some data to a central server, which asserts that the messages are always received in the same order.
1212 This is wrong, and the model-checker correctly finds a counter-example to that assertion.
1213
1214 .. tabs::
1215
1216    .. example-tab:: examples/cpp/mc-failing-assert/s4u-mc-failing-assert.cpp
1217
1218 .. |br| raw:: html
1219
1220    <br />