docs/source/app_s4u.rst

   1 .. _S4U_doc:
   2
   3 The S4U Interface
   4 #################
   5
   6 .. raw:: html
   7
   8    <object id="TOC" data="graphical-toc.svg" type="image/svg+xml"></object>
   9    <script>
  10    window.onload=function() { // Wait for the SVG to be loaded before changing it
  11      var elem=document.querySelector("#TOC").contentDocument.getElementById("ActorBox")
  12      elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
  13    }
  14    </script>
  15    <br/>
  16    <br/>
  17
  18 The S4U interface (SimGrid for you) mixes the full power of SimGrid
  19 with the full power of C++. This is the preferred interface to describe
  20 abstract algorithms in the domains of Cloud, P2P, HPC, IoT, and similar
  21 settings.
  22
  23 Since v3.20 (June 2018), S4U is definitely the way to go for long-term
  24 projects. It is feature complete, but may still evolve slightly in the
  25 future releases. It can already be used to do everything that can be
  26 done in SimGrid, but you may have to adapt your code in future
  27 releases. When this happens, compiling your code will produce
  28 deprecation warnings for 4 releases (one year) before the removal of
  29 the old symbols.
  30 If you want an API that will never ever evolve in the future, you
  31 should use the :ref:`deprecated MSG API <MSG_doc>` instead.
  32
  33 Main Concepts
  34 *************
  35
  36 A typical SimGrid simulation is composed of several |API_s4u_Actors|_, that
  37 execute user-provided functions. The actors have to explicitly use the
  38 S4U interface to express their :ref:`computation <API_s4u_Exec>`,
  39 :ref:`communication <API_s4u_Comm>`, :ref:`disk usage <API_s4u_Io>`,
  40 and other |API_s4u_Activities|_, so that they get reflected within the
  41 simulator. These activities take place on resources such as |API_s4u_Hosts|_,
  42 |API_s4u_Links|_ and |API_s4u_Disks|_. SimGrid predicts the time taken by each
  43 activity and orchestrates the actors accordingly, waiting for the
  44 completion of these activities.
  45
  46
  47 When **communicating**, data is not directly sent to other actors but
  48 posted onto a |API_s4u_Mailbox|_ that serves as a rendez-vous point between
  49 communicating actors. This means that you don't need to know who you
  50 are talking to, you just put your communication `Put` request in a
  51 mailbox, and it will be matched with a complementary `Get`
  52 request.  Alternatively, actors can interact through **classical
  53 synchronization mechanisms** such as |API_s4u_Barrier|_, |API_s4u_Semaphore|_,
  54 |API_s4u_Mutex|_ and |API_s4u_ConditionVariable|_.
  55
  56 Each actor is located on a simulated |API_s4u_Host|_. Each host is located
  57 itself in a |API_s4u_NetZone|_, that knows the networking path between one
  58 resource to another. Each NetZone is included in another one, forming
  59 a tree of NetZones which root zone contains the whole platform. The
  60 actors can also be located on a |API_s4U_VirtualMachine|_ that may
  61 restrict the activities it contains to a limited amount of cores.
  62 Virtual machines can also be migrated between hosts.
  63
  64 The :ref:`simgrid::s4u::this_actor <API_s4u_this_actor>` namespace
  65 provides many helper functions to simplify the code of actors.
  66
  67 - **Global Classes**
  68
  69   - :ref:`class s4u::Actor <API_s4u_Actor>`:
  70     Active entities executing your application.
  71   - :ref:`class s4u::Engine <API_s4u_Engine>`
  72     Simulation engine (singleton).
  73   - :ref:`class s4u::Mailbox <API_s4u_Mailbox>`
  74     Communication rendez-vous.
  75
  76 - **Platform Elements**
  77
  78   - :ref:`class s4u::Disk <API_s4u_Disk>`
  79     Resource on which actors can write and read data.
  80   - :ref:`class s4u::Host <API_s4u_Host>`:
  81     Actor location, providing computational power.
  82   - :ref:`class s4u::Link <API_s4u_Link>`
  83     Interconnecting hosts.
  84   - :ref:`class s4u::NetZone <API_s4u_NetZone>`:
  85     Sub-region of the platform, containing resources (Hosts, Links, etc).
  86   - :ref:`class s4u::VirtualMachine <API_s4u_VirtualMachine>`:
  87     Execution containers that can be moved between Hosts.
  88
  89 - **Activities** (:ref:`class s4u::Activity <API_s4u_Activity>`):
  90   The things that actors can do on resources
  91
  92   - :ref:`class s4u::Comm <API_s4u_Comm>`
  93     Communication activity, started on Mailboxes and consuming links.
  94   - :ref:`class s4u::Exec <API_s4u_Exec>`
  95     Computation activity, started on Host and consuming CPU resources.
  96   - :ref:`class s4u::Io <API_s4u_Io>`
  97     I/O activity, started on and consumming disks.
  98
  99 - **Synchronization Mechanisms**: Classical IPC that actors can use
 100
 101   - :ref:`class s4u::Barrier <API_s4u_Barrier>`
 102   - :ref:`class s4u::ConditionVariable <API_s4u_ConditionVariable>`
 103   - :ref:`class s4u::Mutex <API_s4u_Mutex>`
 104   - :ref:`class s4u::Semaphore <API_s4u_Semaphore>`
 105
 106
 107 .. |API_s4u_Actors| replace:: **Actors**
 108 .. _API_s4u_Actors: #s4u-actor
 109
 110 .. |API_s4u_Activities| replace:: **Activities**
 111 .. _API_s4u_Activities: #s4u-activity
 112
 113 .. |API_s4u_Hosts| replace:: **Hosts**
 114 .. _API_s4u_Hosts: #s4u-host
 115
 116 .. |API_s4u_Links| replace:: **Links**
 117 .. _API_s4u_Links: #s4u-link
 118
 119 .. |API_s4u_Disks| replace:: **Disks**
 120 .. _API_s4u_Disks: #s4u-disk
 121
 122 .. |API_s4u_VirtualMachine| replace:: **VirtualMachines**
 123
 124 .. |API_s4u_Host| replace:: **Host**
 125
 126 .. |API_s4u_Mailbox| replace:: **Mailbox**
 127
 128 .. |API_s4u_Mailboxes| replace:: **Mailboxes**
 129 .. _API_s4u_Mailboxes: #s4u-mailbox
 130
 131 .. |API_s4u_NetZone| replace:: **NetZone**
 132
 133 .. |API_s4u_Barrier| replace:: **Barrier**
 134
 135 .. |API_s4u_Semaphore| replace:: **Semaphore**
 136
 137 .. |API_s4u_ConditionVariable| replace:: **ConditionVariable**
 138
 139 .. |API_s4u_Mutex| replace:: **Mutex**
 140
 141 Activities
 142 **********
 143
 144 Activities represent the actions that consume a resource, such as a
 145 :ref:`s4u::Comm <API_s4u_Comm>` that consumes the *transmitting power* of
 146 :ref:`s4u::Link <API_s4u_Link>` resources.
 147
 148 =======================
 149 Asynchronous Activities
 150 =======================
 151
 152 Every activity can be either **blocking** or **asynchronous**. For
 153 example, :cpp:func:`s4u::Mailbox::put() <simgrid::s4u::Mailbox::put>`
 154 and :cpp:func:`s4u::Mailbox::get() <simgrid::s4u::Mailbox::get>`
 155 create blocking communications: the actor is blocked until the
 156 completion of that communication. Asynchronous communications do not
 157 block the actor during their execution but progress on their own.
 158
 159 Once your asynchronous activity is started, you can test for its
 160 completion using :cpp:func:`s4u::Activity::test() <simgrid::s4u::Activity::test>`.
 161 This function returns ``true`` if the activity completed already.
 162 You can also use :cpp:func:`s4u::Activity::wait() <simgrid::s4u::Activity::wait>`
 163 to block until the completion of the activity. To wait for at most a given amount of time,
 164 use  :cpp:func:`s4u::Activity::wait_for() <simgrid::s4u::Activity::wait_for>`.
 165 Finally, to wait at most until a specified time limit, use
 166 :cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
 167
 168 .. todo::
 169
 170    wait_for and wait_until are currently not implemented for Exec and Io activities.
 171
 172 Every kind of activity can be asynchronous:
 173
 174   - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
 175     :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
 176     :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`.
 177   - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
 178     :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
 179     :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`.
 180   - :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
 181     :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
 182   - In the future, it will become possible to have asynchronous IPC
 183     such as asynchronous mutex lock requests.
 184
 185 The following example shows how to have several concurrent
 186 communications ongoing.  First, you have to declare a vector in which
 187 we will store the ongoing communications. It is also useful to have a
 188 vector of mailboxes.
 189
 190 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
 191    :language: c++
 192    :start-after: init-begin
 193    :end-before: init-end
 194    :dedent: 4
 195
 196 Then, you start all the communications that should occur concurrently with
 197 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
 198 Finally, the actor waits for the completion of all of them at once
 199 with
 200 :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
 201
 202 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
 203    :language: c++
 204    :start-after: put-begin
 205    :end-before: put-end
 206    :dedent: 4
 207
 208
 209 =====================
 210 Activities Life cycle
 211 =====================
 212
 213 Sometimes, you want to change the setting of an activity before it even starts.
 214
 215 .. todo:: write this section
 216
 217 .. _s4u_mailbox:
 218
 219 Mailboxes
 220 *********
 221
 222 Please also refer to the :ref:`API reference for s4u::Mailbox
 223 <API_s4u_Mailbox>`.
 224
 225 ===================
 226 What are Mailboxes?
 227 ===================
 228
 229 |API_s4u_Mailboxes|_ are rendez-vous points for network communications,
 230 similar to URLs on which you could post and retrieve data. Actually,
 231 the mailboxes are not involved in the communication once it starts,
 232 but only to find the contact with which you want to communicate.
 233
 234 They are similar to many common things: The phone number, which allows
 235 the caller to find the receiver. The twitter hashtag, which help
 236 senders and receivers to find each others. In TCP, the pair
 237 ``{host name, host port}`` to which you can connect to find your peer.
 238 In HTTP, URLs through which the clients can connect to the servers.
 239 In ZeroMQ, the queues are used to match senders and receivers.
 240
 241 One big difference with most of these systems is that no actor is the
 242 exclusive owner of a mailbox, neither in sending nor in receiving.
 243 Many actors can send into and/or receive from the same mailbox.  TCP
 244 socket ports for example are shared on the sender side but exclusive
 245 on the receiver side (only one process can receive from a given socket
 246 at a given point of time).
 247
 248 A big difference with TCP sockets or MPI communications is that
 249 communications do not start right away after a
 250 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put()>`, but wait
 251 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get()>`.
 252 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
 253
 254 A big difference with twitter hashtags is that SimGrid does not
 255 offer easy support to broadcast a given message to many
 256 receivers. So that would be like a twitter tag where each message
 257 is consumed by the first receiver.
 258
 259 A big difference with the ZeroMQ queues is that you cannot filter
 260 on the data you want to get from the mailbox. To model such settings
 261 in SimGrid, you'd have one mailbox per potential topic, and subscribe
 262 to each topic individually with a
 263 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async()>` on each mailbox.
 264 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any()>`
 265 to get the first message on any of the mailbox you are subscribed onto.
 266
 267 The mailboxes are not located on the network, and you can access
 268 them without any latency. The network delay are only related to the
 269 location of the sender and receiver once the match between them is
 270 done on the mailbox. This is just like the phone number that you
 271 can use locally, and the geographical distance only comes into play
 272 once you start the communication by dialing this number.
 273
 274 =====================
 275 How to use Mailboxes?
 276 =====================
 277
 278 You can retrieve any existing mailbox from its name (which is a
 279 unique string, just like a twitter tag). This results in a
 280 versatile mechanism that can be used to build many different
 281 situations.
 282
 283 To model classical socket communications, use "hostname:port" as
 284 mailbox names, and make sure that only one actor reads into a given
 285 mailbox. This does not make it easy to build a perfectly realistic
 286 model of the TCP sockets, but in most cases, this system is too
 287 cumbersome for your simulations anyway. You probably want something
 288 simpler, that turns our to be easy to build with the mailboxes.
 289
 290 Many SimGrid examples use a sort of yellow page system where the
 291 mailbox names are the name of the service (such as "worker",
 292 "master" or "reducer"). That way, you don't have to know where your
 293 peer is located to contact it. You don't even need its name. Its
 294 function is enough for that. This also gives you some sort of load
 295 balancing for free if more than one actor pulls from the mailbox:
 296 the first actor that can deal with the request will handle it.
 297
 298 =========================================
 299 How are put() and get() requests matched?
 300 =========================================
 301
 302 The matching algorithm simple: first come, first serve. When a new
 303 send arrives, it matches the oldest enqueued receive. If no receive is
 304 currently enqueued, then the incoming send is enqueued. As you can
 305 see, the mailbox cannot contain both send and receive requests: all
 306 enqueued requests must be of the same sort.
 307
 308 .. _s4u_receiving_actor:
 309
 310 ===========================
 311 Declaring a Receiving Actor
 312 ===========================
 313
 314 The last twist is that by default in the simulator, the data starts
 315 to be exchanged only when both the sender and the receiver are
 316 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 317 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
 318 In TCP, since you establish connections beforehand, the data starts to
 319 flow as soon as the sender posts it, even if the receiver did not post
 320 its :cpp:func:`recv() <simgrid::s4u::Mailbox::recv()>` yet.
 321
 322 To model this in SimGrid, you can declare a specific receiver to a
 323 given mailbox (with the function
 324 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
 325 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 326 posted to that mailbox will start as soon as possible, and the data
 327 will already be there on the receiver host when the receiver actor
 328 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
 329
 330 Note that being permanent receivers of a mailbox prevents actors to be
 331 garbage-collected. If your simulation creates many short-lived actors
 332 that marked as permanent receiver, you should call
 333 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
 334 memory gets properly reclaimed. This call should be at the end of the
 335 actor's function, not in a on_exit callback.
 336
 337 Memory Management
 338 *****************
 339
 340 For sake of simplicity, we use `RAII
 341 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 342 for many classes in S4U. This is an idiom where resources are automatically
 343 managed through the context. Provided that you never manipulate
 344 objects of type Foo directly but always FooPtr references (which are
 345 defined as `boost::intrusive_ptr
 346 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 347 <Foo>), you will never have to explicitly release the resource that
 348 you use nor to free the memory of unused objects.
 349 Here is a little example:
 350
 351 .. code-block:: cpp
 352
 353    void myFunc()
 354    {
 355      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 356
 357      mutex->lock();   // use the mutex as a simple reference
 358      //  bla bla
 359      mutex->unlock();
 360
 361    } // The mutex gets automatically freed because the only existing reference gets out of scope
 362
 363 Note that Mailboxes, Hosts and Links are not handled thought smart
 364 pointers (yet?). This means that it is currently impossible to destroy a
 365 mailbox or a link. You can still destroy an host (but probably
 366 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 367
 368 .. THE EXAMPLES
 369
 370 .. include:: ../../examples/README.rst
 371
 372 API Reference
 373 *************
 374
 375 .. _API_s4u_this_actor:
 376
 377 ==================================
 378 Interacting with the current actor
 379 ==================================
 380
 381 Static methods working on the current actor (see :ref:`API_s4u_Actor`).
 382
 383 .. doxygennamespace:: simgrid::s4u::this_actor
 384
 385 .. _API_s4u_Activity:
 386
 387 =============
 388 s4u::Activity
 389 =============
 390
 391 .. doxygenclass:: simgrid::s4u::Activity
 392    :members:
 393    :protected-members:
 394    :undoc-members:
 395
 396 .. _API_s4u_Actor:
 397
 398 ===========
 399 class Actor
 400 ===========
 401
 402 .. doxygentypedef:: ActorPtr
 403
 404 .. doxygentypedef:: aid_t
 405
 406 .. autodoxyclass:: simgrid::s4u::Actor
 407
 408    .. rubric:: Table of contents
 409
 410    - :ref:`API_s4u_Actor_create`
 411    - :ref:`API_s4u_Actor_search`
 412    - :ref:`API_s4u_Actor_query`
 413    - :ref:`API_s4u_Actor_suspend`
 414    - :ref:`API_s4u_Actor_kill`
 415    - :ref:`API_s4u_Actor_ending`
 416    - :ref:`API_s4u_Actor_signals`
 417
 418    |hr|
 419
 420    .. _API_s4u_Actor_create:
 421
 422    .. rubric:: Creating actors :ref:`(back to top) <API_s4u_Actor>`
 423
 424    .. tabs::
 425
 426       .. group-tab:: C++
 427
 428          .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 429          .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 430          .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 431          .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 432
 433          .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 434          .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 435
 436       .. group-tab:: Python
 437
 438          .. automethod:: simgrid.Actor.create
 439
 440    .. _API_s4u_Actor_search:
 441
 442    .. rubric:: Searching specific actors :ref:`(back to top) <API_s4u_Actor>`
 443
 444    .. tabs::
 445
 446       .. group-tab:: C++
 447
 448          .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 449          .. autodoxymethod:: simgrid::s4u::Actor::self()
 450
 451       .. group-tab:: Python
 452
 453          .. automethod:: simgrid.Actor.by_pid
 454          .. automethod:: simgrid.Actor.self
 455
 456    .. _API_s4u_Actor_query:
 457
 458    .. rubric:: Querying info about actors :ref:`(back to top) <API_s4u_Actor>`
 459
 460    .. tabs::
 461
 462          .. group-tab:: C++
 463
 464             .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 465             .. autodoxymethod:: simgrid::s4u::Actor::get_name
 466             .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 467             .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 468             .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 469             .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 470             .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 471
 472             .. autodoxymethod:: simgrid::s4u::Actor::get_host
 473             .. autodoxymethod:: simgrid::s4u::Actor::migrate
 474
 475             .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
 476             .. autodoxymethod:: simgrid::s4u::Actor::get_impl()
 477
 478          .. group-tab:: Python
 479
 480             .. autoattribute:: simgrid.Actor.name
 481             .. autoattribute:: simgrid.Actor.host
 482             .. autoattribute:: simgrid.Actor.pid
 483             .. autoattribute:: simgrid.Actor.ppid
 484
 485             .. automethod:: simgrid.Actor.migrate
 486
 487    .. _API_s4u_Actor_suspend:
 488
 489    .. rubric:: Suspending and resuming actors :ref:`(back to top) <API_s4u_Actor>`
 490
 491    .. tabs::
 492
 493       .. group-tab:: C++
 494
 495          .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 496          .. autodoxymethod:: simgrid::s4u::Actor::resume()
 497          .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
 498
 499       .. group-tab:: Python
 500
 501          .. automethod:: simgrid.Actor.resume
 502          .. automethod:: simgrid.Actor.suspend
 503          .. automethod:: simgrid.Actor.is_suspended
 504
 505    .. _API_s4u_Actor_kill:
 506
 507    .. rubric:: Killing actors :ref:`(back to top) <API_s4u_Actor>`
 508
 509    .. tabs::
 510
 511       .. group-tab:: C++
 512
 513          .. autodoxymethod:: simgrid::s4u::Actor::kill()
 514          .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 515          .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 516          .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
 517
 518          .. autodoxymethod:: simgrid::s4u::Actor::restart()
 519          .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 520          .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 521
 522       .. group-tab:: Python
 523
 524          .. automethod:: simgrid.Actor.kill
 525          .. automethod:: simgrid.Actor.kill_all
 526
 527          .. automethod:: simgrid.Actor.daemonize
 528          .. automethod:: simgrid.Actor.is_daemon
 529
 530    .. _API_s4u_Actor_ending:
 531
 532    .. rubric:: Reacting to the end of actors :ref:`(back to top) <API_s4u_Actor>`
 533
 534    .. tabs::
 535
 536       .. group-tab:: C++
 537
 538          .. autodoxymethod:: simgrid::s4u::Actor::on_exit(const std::function< void(bool)> &fun)
 539          .. autodoxymethod:: simgrid::s4u::Actor::join()
 540          .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
 541          .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 542
 543       .. group-tab:: Python
 544
 545          .. automethod:: simgrid.Actor.join
 546
 547    .. _API_s4u_Actor_signals:
 548
 549    .. rubric:: Signals :ref:`(back to top) <API_s4u_Actor>`
 550
 551    .. tabs::
 552
 553       .. group-tab:: C++
 554
 555          .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 556          .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 557          .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 558          .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 559          .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 560          .. autodoxyvar:: simgrid::s4u::Actor::on_migration_start
 561          .. autodoxyvar:: simgrid::s4u::Actor::on_migration_end
 562          .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 563          .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 564
 565 .. _API_s4u_Barrier:
 566
 567 ============
 568 s4u::Barrier
 569 ============
 570
 571 .. doxygentypedef:: BarrierPtr
 572
 573 .. doxygenclass:: simgrid::s4u::Barrier
 574    :members:
 575    :protected-members:
 576    :undoc-members:
 577
 578 .. _API_s4u_Comm:
 579
 580 =========
 581 s4u::Comm
 582 =========
 583
 584 .. doxygentypedef:: CommPtr
 585
 586 .. doxygenclass:: simgrid::s4u::Comm
 587    :members:
 588    :protected-members:
 589    :undoc-members:
 590
 591 .. _API_s4u_ConditionVariable:
 592
 593 ======================
 594 s4u::ConditionVariable
 595 ======================
 596
 597 .. doxygentypedef:: ConditionVariablePtr
 598
 599 .. doxygenclass:: simgrid::s4u::ConditionVariable
 600    :members:
 601    :protected-members:
 602    :undoc-members:
 603
 604 .. _API_s4u_Disk:
 605
 606 ============
 607 s4u::Disk
 608 ============
 609
 610 .. doxygenclass:: simgrid::s4u::Disk
 611    :members:
 612    :protected-members:
 613    :undoc-members:
 614
 615 .. _API_s4u_Engine:
 616
 617 ===========
 618 s4u::Engine
 619 ===========
 620
 621 .. doxygenclass:: simgrid::s4u::Engine
 622    :members:
 623    :protected-members:
 624    :undoc-members:
 625
 626 .. _API_s4u_Exec:
 627
 628 =========
 629 s4u::Exec
 630 =========
 631
 632 .. doxygentypedef:: ExecPtr
 633
 634 .. doxygenclass:: simgrid::s4u::Exec
 635    :members:
 636    :protected-members:
 637    :undoc-members:
 638
 639 .. _API_s4u_ExecSeq:
 640
 641 ============
 642 s4u::ExecSeq
 643 ============
 644
 645 .. doxygentypedef:: ExecSeqPtr
 646
 647 .. doxygenclass:: simgrid::s4u::ExecSeq
 648    :members:
 649    :protected-members:
 650    :undoc-members:
 651
 652 .. _API_s4u_ExecPar:
 653
 654 ============
 655 s4u::ExecPar
 656 ============
 657
 658 .. doxygentypedef:: ExecParPtr
 659
 660 .. doxygenclass:: simgrid::s4u::ExecPar
 661    :members:
 662    :protected-members:
 663    :undoc-members:
 664
 665 .. _API_s4u_Host:
 666
 667 =========
 668 s4u::Host
 669 =========
 670
 671 .. doxygenclass:: simgrid::s4u::Host
 672    :members:
 673    :protected-members:
 674    :undoc-members:
 675
 676 .. _API_s4u_Io:
 677
 678 =======
 679 s4u::Io
 680 =======
 681
 682 .. doxygentypedef:: IoPtr
 683
 684 .. doxygenclass:: simgrid::s4u::Io
 685    :members:
 686    :protected-members:
 687    :undoc-members:
 688
 689 .. _API_s4u_Link:
 690
 691 =========
 692 s4u::Link
 693 =========
 694
 695 .. doxygenclass:: simgrid::s4u::Link
 696    :members:
 697    :protected-members:
 698    :undoc-members:
 699
 700 .. _API_s4u_Mailbox:
 701
 702 ============
 703 s4u::Mailbox
 704 ============
 705
 706 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 707
 708 .. doxygenclass:: simgrid::s4u::Mailbox
 709    :members:
 710    :protected-members:
 711    :undoc-members:
 712
 713 .. _API_s4u_Mutex:
 714
 715 ==========
 716 s4u::Mutex
 717 ==========
 718
 719 .. doxygentypedef:: MutexPtr
 720
 721 .. doxygenclass:: simgrid::s4u::Mutex
 722    :members:
 723    :protected-members:
 724    :undoc-members:
 725
 726 .. _API_s4u_NetZone:
 727
 728 ============
 729 s4u::NetZone
 730 ============
 731
 732 .. doxygenclass:: simgrid::s4u::NetZone
 733    :members:
 734    :protected-members:
 735    :undoc-members:
 736
 737 .. _API_s4u_Semaphore:
 738
 739 ==============
 740 s4u::Semaphore
 741 ==============
 742
 743 .. doxygentypedef:: SemaphorePtr
 744
 745 .. doxygenclass:: simgrid::s4u::Semaphore
 746    :members:
 747    :protected-members:
 748    :undoc-members:
 749
 750 .. _API_s4u_VirtualMachine:
 751
 752 ===================
 753 s4u::VirtualMachine
 754 ===================
 755
 756 .. doxygenclass:: simgrid::s4u::VirtualMachine
 757    :members:
 758    :protected-members:
 759    :undoc-members:
 760
 761 C API Reference
 762 ***************
 763
 764 ==============
 765 Main functions
 766 ==============
 767
 768 .. doxygenfunction:: simgrid_init
 769 .. doxygenfunction:: simgrid_get_clock
 770 .. doxygenfunction:: simgrid_load_deployment
 771 .. doxygenfunction:: simgrid_load_platform
 772 .. doxygenfunction:: simgrid_register_default
 773 .. doxygenfunction:: simgrid_register_function
 774 .. doxygenfunction:: simgrid_run
 775
 776 ==================
 777 Condition Variable
 778 ==================
 779
 780 See also the :ref:`C++ API <API_s4u_ConditionVariable>`.
 781
 782 .. doxygenfunction:: sg_cond_init
 783 .. doxygenfunction:: sg_cond_notify_all
 784 .. doxygenfunction:: sg_cond_notify_one
 785 .. doxygenfunction:: sg_cond_wait
 786 .. doxygenfunction:: sg_cond_wait_for
 787
 788 Python API Reference
 789 ********************
 790
 791 The Python API is automatically generated with pybind11. It closely mimicks the C++
 792 API, to which you should refer for more information.
 793
 794 ==========
 795 this_actor
 796 ==========
 797
 798 .. automodule:: simgrid.this_actor
 799    :members:
 800
 801 ===========
 802 Class Actor
 803 ===========
 804
 805 .. autoclass:: simgrid.Actor
 806    :members:
 807
 808 ==========
 809 Class Comm
 810 ==========
 811
 812 .. autoclass:: simgrid.Comm
 813    :members:
 814
 815 ============
 816 Class Engine
 817 ============
 818
 819 .. autoclass:: simgrid.Engine
 820    :members:
 821
 822 ==========
 823 Class Exec
 824 ==========
 825
 826 .. autoclass:: simgrid.Exec
 827    :members:
 828
 829 ==========
 830 Class Host
 831 ==========
 832
 833 .. autoclass:: simgrid.Host
 834    :members:
 835
 836 =============
 837 Class Mailbox
 838 =============
 839
 840 .. autoclass:: simgrid.Mailbox
 841    :members:
 842
 843 .. |hr| raw:: html
 844
 845    <hr />