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