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