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 .. _s4u_raii:
 342
 343 Memory Management
 344 *****************
 345
 346 For sake of simplicity, we use `RAII
 347 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 348 for many classes in S4U. This is an idiom where resources are automatically
 349 managed through the context. Provided that you never manipulate
 350 objects of type Foo directly but always FooPtr references (which are
 351 defined as `boost::intrusive_ptr
 352 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 353 <Foo>), you will never have to explicitly release the resource that
 354 you use nor to free the memory of unused objects.
 355 Here is a little example:
 356
 357 .. code-block:: cpp
 358
 359    void myFunc()
 360    {
 361      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 362
 363      mutex->lock();   // use the mutex as a simple reference
 364      //  bla bla
 365      mutex->unlock();
 366
 367    } // The mutex gets automatically freed because the only existing reference gets out of scope
 368
 369 Note that Mailboxes, Hosts and Links are not handled thought smart
 370 pointers (yet?). This means that it is currently impossible to destroy a
 371 mailbox or a link. You can still destroy an host (but probably
 372 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 373
 374 .. THE EXAMPLES
 375
 376 .. include:: ../../examples/README.rst
 377
 378 API Reference
 379 *************
 380
 381 .. _API_s4u_simulation_object:
 382
 383 ==================
 384 Simulation objects
 385 ==================
 386
 387 .. _API_s4u_Actor:
 388
 389 ==============
 390 ⁣  class Actor
 391 ==============
 392
 393 .. autodoxyclass:: simgrid::s4u::Actor
 394
 395 .. doxygentypedef:: ActorPtr
 396
 397 .. doxygentypedef:: aid_t
 398
 399 Creating actors
 400 ---------------
 401
 402 .. tabs::
 403
 404    .. group-tab:: C++
 405
 406       .. code:: C++
 407
 408          #include <simgrid/s4u/Engine.hpp>
 409
 410       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 411       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 412       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 413       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 414
 415       .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 416       .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 417
 418    .. group-tab:: Python
 419
 420       .. code:: Python
 421
 422          from simgrid import Actor
 423
 424       .. automethod:: simgrid.Actor.create
 425
 426    .. group-tab:: C
 427
 428       .. code:: C
 429
 430          #include <simgrid/actor.h>
 431
 432       .. doxygentypedef:: sg_actor_t
 433       .. cpp:type:: const s4u_Actor* const_sg_actor_t
 434
 435          Pointer to a constant actor object.
 436
 437       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
 438       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
 439
 440       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 441       .. autodoxymethod:: sg_actor_detach()
 442
 443       .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
 444       .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
 445
 446 Searching specific actors
 447 -------------------------
 448
 449 .. tabs::
 450
 451    .. group-tab:: C++
 452
 453       .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 454       .. autodoxymethod:: simgrid::s4u::Actor::self()
 455
 456    .. group-tab:: Python
 457
 458       .. automethod:: simgrid.Actor.by_pid
 459       .. automethod:: simgrid.Actor.self
 460
 461    .. group-tab:: C
 462
 463       .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
 464       .. autodoxymethod:: sg_actor_self()
 465
 466 Querying info about actors
 467 --------------------------
 468
 469 .. tabs::
 470
 471    .. group-tab:: C++
 472
 473       .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 474       .. autodoxymethod:: simgrid::s4u::Actor::get_name
 475       .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 476       .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 477       .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 478       .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 479       .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 480
 481       .. autodoxymethod:: simgrid::s4u::Actor::get_host
 482       .. autodoxymethod:: simgrid::s4u::Actor::set_host
 483
 484       .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
 485       .. autodoxymethod:: simgrid::s4u::Actor::get_impl
 486
 487    .. group-tab:: Python
 488
 489       .. autoattribute:: simgrid.Actor.name
 490       .. autoattribute:: simgrid.Actor.host
 491       .. autoattribute:: simgrid.Actor.pid
 492       .. autoattribute:: simgrid.Actor.ppid
 493
 494    .. group-tab:: C
 495
 496       .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
 497       .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
 498       .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
 499       .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
 500       .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 501
 502       .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
 503       .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 504
 505       .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor)
 506       .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata)
 507
 508 Suspending and resuming actors
 509 ------------------------------
 510
 511 .. tabs::
 512
 513    .. group-tab:: C++
 514
 515       .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 516       .. autodoxymethod:: simgrid::s4u::Actor::resume()
 517       .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
 518
 519    .. group-tab:: Python
 520
 521       .. automethod:: simgrid.Actor.resume
 522       .. automethod:: simgrid.Actor.suspend
 523       .. automethod:: simgrid.Actor.is_suspended
 524
 525    .. group-tab:: C
 526
 527       .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
 528       .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
 529       .. autodoxymethod:: sg_actor_is_suspended(sg_actor_t actor)
 530
 531 Specifying when actors should terminate
 532 ---------------------------------------
 533
 534 .. tabs::
 535
 536    .. group-tab:: C++
 537
 538       .. autodoxymethod:: simgrid::s4u::Actor::kill()
 539       .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 540       .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 541       .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
 542
 543       .. autodoxymethod:: simgrid::s4u::Actor::restart()
 544       .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 545       .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 546
 547    .. group-tab:: Python
 548
 549       .. automethod:: simgrid.Actor.kill
 550       .. automethod:: simgrid.Actor.kill_all
 551
 552       .. automethod:: simgrid.Actor.daemonize
 553       .. automethod:: simgrid.Actor.is_daemon
 554
 555    .. group-tab:: C
 556
 557       .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
 558       .. autodoxymethod:: sg_actor_kill_all()
 559       .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 560
 561       .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
 562       .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
 563
 564 .. _API_s4u_Actor_end:
 565
 566 Reacting to the end of actors
 567 -----------------------------
 568
 569 .. tabs::
 570
 571    .. group-tab:: C++
 572
 573       .. autodoxymethod:: simgrid::s4u::Actor::on_exit
 574       .. autodoxymethod:: simgrid::s4u::Actor::join()
 575       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
 576       .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 577
 578    .. group-tab:: Python
 579
 580       .. automethod:: simgrid.Actor.join
 581
 582    .. group-tab:: C
 583
 584       .. autodoxymethod:: sg_actor_join(sg_actor_t actor, double timeout)
 585       .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 586
 587 Signals
 588 -------
 589
 590 .. tabs::
 591
 592    .. group-tab:: C++
 593
 594       .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 595       .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 596       .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 597       .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 598       .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 599       .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 600       .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 601
 602 .. _API_s4u_this_actor:
 603
 604 ====================
 605 ⁣  The current actor
 606 ====================
 607
 608 These functions can be used in your user code to interact with the actor
 609 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 610 Using these functions can greatly improve the code readability.
 611
 612 Querying info
 613 -------------
 614
 615 .. tabs::
 616
 617    .. group-tab:: C++
 618
 619       .. autodoxymethod:: simgrid::s4u::this_actor::get_cname()
 620       .. autodoxymethod:: simgrid::s4u::this_actor::get_name()
 621       .. autodoxymethod:: simgrid::s4u::this_actor::get_pid()
 622       .. autodoxymethod:: simgrid::s4u::this_actor::get_ppid()
 623       .. autodoxymethod:: simgrid::s4u::this_actor::is_maestro()
 624
 625       .. autodoxymethod:: simgrid::s4u::this_actor::get_host()
 626       .. autodoxymethod:: simgrid::s4u::this_actor::set_host(Host *new_host)
 627
 628    .. group-tab:: Python
 629
 630       .. autofunction:: simgrid.this_actor.get_host
 631       .. autofunction:: simgrid.this_actor.set_host
 632
 633    .. group-tab:: C
 634
 635       .. autodoxymethod:: sg_actor_self_data()
 636       .. autodoxymethod:: sg_actor_self_data_set(void *data)
 637       .. autodoxymethod:: sg_actor_self_get_name()
 638       .. autodoxymethod:: sg_actor_self_get_pid()
 639       .. autodoxymethod:: sg_actor_self_get_ppid()
 640       .. autodoxymethod:: sg_host_self()
 641       .. autodoxymethod:: sg_host_self_get_name()
 642
 643 Suspending and resuming
 644 -----------------------
 645
 646 .. tabs::
 647
 648    .. group-tab:: C++
 649
 650       .. autodoxymethod:: simgrid::s4u::this_actor::suspend()
 651       .. autodoxymethod:: simgrid::s4u::this_actor::yield()
 652
 653    .. group-tab:: Python
 654
 655       .. autofunction:: simgrid.this_actor.suspend
 656       .. autofunction:: simgrid.this_actor.yield_
 657
 658 Logging messages
 659 ----------------
 660
 661 .. tabs::
 662
 663    .. group-tab:: Python
 664
 665        .. autofunction:: simgrid.this_actor.info
 666        .. autofunction:: simgrid.this_actor.error
 667
 668 Sleeping
 669 --------
 670
 671 .. tabs::
 672
 673    .. group-tab:: C++
 674
 675       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(double duration)
 676       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
 677       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
 678       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
 679
 680    .. group-tab:: Python
 681
 682       .. autofunction:: simgrid.this_actor.sleep_for
 683       .. autofunction:: simgrid.this_actor.sleep_until
 684
 685    .. group-tab:: C
 686
 687       .. autodoxymethod:: sg_actor_sleep_for(double duration)
 688
 689 Simulating executions
 690 ---------------------
 691
 692 Simulate the execution of some code on this actor. You can either simulate
 693 parallel or sequential code, and you can either block upon the termination of
 694 the execution, or start an asynchronous activity.
 695
 696 .. tabs::
 697
 698    .. group-tab:: C++
 699
 700       .. autodoxymethod:: simgrid::s4u::this_actor::exec_async(double flops_amounts)
 701       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 702       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
 703       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
 704       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
 705       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 706       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
 707
 708    .. group-tab:: Python
 709
 710       .. autofunction:: simgrid.this_actor.exec_init
 711       .. autofunction:: simgrid.this_actor.execute
 712
 713    .. group-tab:: C
 714
 715       .. autodoxymethod:: sg_actor_self_execute(double flops)
 716
 717 Exiting
 718 -------
 719
 720 .. tabs::
 721
 722    .. group-tab:: C++
 723
 724       .. autodoxymethod:: simgrid::s4u::this_actor::exit()
 725       .. autodoxymethod:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 726
 727    .. group-tab:: Python
 728
 729       .. autofunction:: simgrid.this_actor.exit
 730       .. autofunction:: simgrid.this_actor.on_exit
 731
 732 .. _API_s4u_Engine:
 733
 734 ====================
 735 ⁣  Simulation Engine
 736 ====================
 737
 738 .. autodoxyclass:: simgrid::s4u::Engine
 739
 740 Initialization
 741 --------------
 742
 743 .. tabs::
 744
 745    .. group-tab:: C++
 746
 747       .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 748       .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
 749       .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
 750       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
 751
 752       .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
 753       .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
 754       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
 755       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 756       .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
 757       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
 758       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
 759
 760    .. group-tab:: Python
 761
 762        .. automethod:: simgrid.Engine.load_deployment
 763        .. automethod:: simgrid.Engine.load_platform
 764        .. automethod:: simgrid.Engine.register_actor
 765
 766    .. group-tab:: C
 767
 768       .. autodoxymethod:: simgrid_init
 769
 770       .. autodoxymethod:: simgrid_load_deployment
 771       .. autodoxymethod:: simgrid_load_platform
 772       .. autodoxymethod:: simgrid_register_default
 773       .. autodoxymethod:: simgrid_register_function
 774
 775 Run the simulation
 776 ------------------
 777
 778 .. tabs::
 779
 780    .. group-tab:: C++
 781
 782       .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
 783       .. autodoxymethod:: simgrid::s4u::Engine::run()
 784
 785    .. group-tab:: Python
 786
 787       .. automethod:: simgrid.Engine.get_clock
 788       .. automethod:: simgrid.Engine.run
 789
 790    .. group-tab:: C
 791
 792       .. autodoxymethod:: simgrid_get_clock
 793       .. autodoxymethod:: simgrid_run
 794
 795 Retrieving actors
 796 -----------------
 797
 798 .. tabs::
 799
 800    .. group-tab:: C++
 801
 802       .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
 803       .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
 804       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
 805
 806    .. group-tab:: C
 807
 808       .. autodoxymethod:: simgrid_get_actor_count()
 809
 810 Retrieving hosts
 811 ----------------
 812
 813 .. tabs::
 814
 815    .. group-tab:: C++
 816
 817       .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
 818       .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
 819       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
 820       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
 821       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
 822
 823    .. group-tab:: Python
 824
 825       .. automethod:: simgrid.Engine.get_all_hosts
 826
 827 Retrieving links
 828 ----------------
 829
 830 .. tabs::
 831
 832    .. group-tab:: C++
 833
 834       .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
 835       .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
 836       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
 837       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
 838       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
 839
 840 Interacting with the routing
 841 ----------------------------
 842
 843 .. tabs::
 844
 845    .. group-tab:: C++
 846
 847       .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
 848       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
 849       .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
 850       .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
 851       .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
 852       .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
 853       .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 854
 855 Signals
 856 -------
 857
 858 .. tabs::
 859
 860    .. group-tab:: C++
 861
 862       .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
 863       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
 864       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
 865       .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
 866       .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
 867
 868 .. _API_s4u_Mailbox:
 869
 870 ================
 871 ⁣  class Mailbox
 872 ================
 873
 874 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 875
 876 .. doxygenclass:: simgrid::s4u::Mailbox
 877    :members:
 878    :protected-members:
 879    :undoc-members:
 880 .. _API_s4u_Resource:
 881
 882 =========
 883 Resources
 884 =========
 885
 886 .. _API_s4u_Disk:
 887
 888 =============
 889 ⁣  class Disk
 890 =============
 891
 892 .. doxygenclass:: simgrid::s4u::Disk
 893    :members:
 894    :protected-members:
 895    :undoc-members:
 896
 897
 898
 899 .. _API_s4u_Host:
 900
 901 =============
 902 ⁣  class Host
 903 =============
 904
 905 .. doxygenclass:: simgrid::s4u::Host
 906    :members:
 907    :protected-members:
 908    :undoc-members:
 909
 910 .. _API_s4u_Link:
 911
 912 =============
 913 ⁣  class Link
 914 =============
 915
 916 .. doxygenclass:: simgrid::s4u::Link
 917    :members:
 918    :protected-members:
 919    :undoc-members:
 920
 921 .. _API_s4u_NetZone:
 922
 923 ================
 924 ⁣  class NetZone
 925 ================
 926
 927 .. doxygenclass:: simgrid::s4u::NetZone
 928    :members:
 929    :protected-members:
 930    :undoc-members:
 931
 932 .. _API_s4u_VirtualMachine:
 933
 934 =======================
 935 ⁣  class VirtualMachine
 936 =======================
 937
 938 .. doxygenclass:: simgrid::s4u::VirtualMachine
 939    :members:
 940    :protected-members:
 941    :undoc-members:
 942
 943 .. autodoxymethod:: sg_vm_create_core
 944 .. autodoxymethod:: sg_vm_create_multicore
 945 .. autodoxymethod:: sg_vm_get_name
 946 .. autodoxymethod:: sg_vm_get_pm
 947 .. autodoxymethod:: sg_vm_is_created
 948 .. autodoxymethod:: sg_vm_is_running
 949 .. autodoxymethod:: sg_vm_is_suspended
 950 .. autodoxymethod:: sg_vm_start
 951 .. autodoxymethod:: sg_vm_suspend
 952 .. autodoxymethod:: sg_vm_resume
 953 .. autodoxymethod:: sg_vm_shutdown
 954 .. autodoxymethod:: sg_vm_destroy
 955
 956 .. _API_s4u_Activity:
 957
 958 ==============
 959 class Activity
 960 ==============
 961
 962 .. autodoxyclass:: simgrid::s4u::Activity
 963
 964    **Known subclasses:**
 965    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
 966    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
 967    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
 968    See also the :ref:`section on activities <s4u_Activities>` above.
 969
 970 Querying info about activities
 971 ------------------------------
 972
 973    .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
 974    .. autodoxymethod:: simgrid::s4u::Activity::get_state()
 975    .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
 976    .. autodoxymethod:: simgrid::s4u::Activity::get_impl
 977
 978 Activities lifecycle
 979 --------------------
 980
 981    .. autodoxymethod:: simgrid::s4u::Activity::start
 982    .. autodoxymethod:: simgrid::s4u::Activity::cancel
 983    .. autodoxymethod:: simgrid::s4u::Activity::test
 984    .. autodoxymethod:: simgrid::s4u::Activity::wait
 985    .. autodoxymethod:: simgrid::s4u::Activity::wait_for
 986    .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
 987
 988 .. _API_s4u_Comm:
 989
 990 =============
 991 ⁣  class Comm
 992 =============
 993
 994 .. doxygentypedef:: CommPtr
 995
 996 .. doxygenclass:: simgrid::s4u::Comm
 997    :members:
 998    :protected-members:
 999    :undoc-members:
1000
1001 .. _API_s4u_Exec:
1002
1003 =============
1004 ⁣  class Exec
1005 =============
1006
1007 .. doxygentypedef:: ExecPtr
1008
1009 .. doxygenclass:: simgrid::s4u::Exec
1010    :members:
1011    :protected-members:
1012    :undoc-members:
1013
1014 .. _API_s4u_ExecSeq:
1015
1016 ==================
1017 ⁣    class ExecSeq
1018 ==================
1019
1020 .. doxygentypedef:: ExecSeqPtr
1021
1022 .. doxygenclass:: simgrid::s4u::ExecSeq
1023    :members:
1024    :protected-members:
1025    :undoc-members:
1026
1027 .. _API_s4u_ExecPar:
1028
1029 ==================
1030 ⁣    class ExecPar
1031 ==================
1032
1033 .. doxygentypedef:: ExecParPtr
1034
1035 .. doxygenclass:: simgrid::s4u::ExecPar
1036    :members:
1037    :protected-members:
1038    :undoc-members:
1039
1040 .. _API_s4u_Io:
1041
1042 ===========
1043 ⁣  class Io
1044 ===========
1045
1046 .. doxygentypedef:: IoPtr
1047
1048 .. doxygenclass:: simgrid::s4u::Io
1049    :members:
1050    :protected-members:
1051    :undoc-members:
1052
1053 .. _API_s4u_Synchronizations:
1054
1055 =======================
1056 Synchronization Objects
1057 =======================
1058
1059 .. _API_s4u_Mutex:
1060
1061 ==============
1062 ⁣  Mutex
1063 ==============
1064
1065 .. autodoxyclass:: simgrid::s4u::Mutex
1066
1067 Basic management
1068 ----------------
1069
1070    .. tabs::
1071
1072       .. group-tab:: C++
1073
1074          .. code-block:: C++
1075
1076             #include <simgrid/s4u/Mutex.hpp>
1077
1078          .. doxygentypedef:: MutexPtr
1079
1080          .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
1081          .. autodoxymethod:: simgrid::s4u::Mutex::create()
1082          .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
1083
1084       .. group-tab:: C
1085
1086          .. code-block:: C
1087
1088             #include <simgrid/mutex.h>
1089
1090          .. doxygentypedef:: sg_mutex_t
1091          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
1092
1093             Pointer to a constant mutex object.
1094
1095          .. autodoxymethod:: sg_mutex_init()
1096          .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
1097
1098 Locking
1099 -------
1100
1101    .. tabs::
1102
1103       .. group-tab:: C++
1104
1105          .. autodoxymethod:: simgrid::s4u::Mutex::lock()
1106          .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
1107          .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
1108
1109       .. group-tab:: C
1110
1111          .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
1112          .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
1113          .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
1114
1115 .. _API_s4u_Barrier:
1116
1117 ================
1118 ⁣  Barrier
1119 ================
1120
1121 .. autodoxyclass:: simgrid::s4u::Barrier
1122
1123    .. tabs::
1124
1125       .. group-tab:: C++
1126
1127          .. code-block:: C++
1128
1129             #include <simgrid/s4u/Barrier.hpp>
1130
1131          .. doxygentypedef:: BarrierPtr
1132
1133          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
1134          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
1135          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
1136
1137       .. group-tab:: C
1138
1139          .. code-block:: C
1140
1141             #include <simgrid/barrier.hpp>
1142
1143          .. doxygentypedef:: sg_bar_t
1144          .. cpp:type:: const s4u_Barrier* const_sg_bar_t
1145
1146             Pointer to a constant barrier object.
1147
1148          .. autodoxymethod:: sg_barrier_init(unsigned int count)
1149          .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
1150          .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
1151
1152
1153 .. _API_s4u_ConditionVariable:
1154
1155 ==========================
1156 ⁣  Condition variable
1157 ==========================
1158
1159 .. autodoxyclass:: simgrid::s4u::ConditionVariable
1160
1161 Basic management
1162 ----------------
1163
1164    .. tabs::
1165
1166       .. group-tab:: C++
1167
1168          .. code-block:: C++
1169
1170             #include <simgrid/s4u/ConditionVariable.hpp>
1171
1172          .. doxygentypedef:: ConditionVariablePtr
1173
1174          .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
1175
1176       .. group-tab:: C
1177
1178          .. code-block:: C
1179
1180             #include <simgrid/cond.h>
1181
1182          .. doxygentypedef:: sg_cond_t
1183          .. doxygenfunction:: sg_cond_init
1184          .. doxygenfunction:: sg_cond_destroy
1185
1186 Waiting and notifying
1187 ---------------------
1188
1189    .. tabs::
1190
1191       .. group-tab:: C++
1192
1193          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
1194          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
1195          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
1196          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
1197          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
1198          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
1199          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
1200          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
1201          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
1202          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
1203          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
1204          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
1205          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
1206
1207       .. group-tab:: C
1208
1209          .. doxygenfunction:: sg_cond_notify_all
1210          .. doxygenfunction:: sg_cond_notify_one
1211          .. doxygenfunction:: sg_cond_wait
1212          .. doxygenfunction:: sg_cond_wait_for
1213
1214 .. _API_s4u_Semaphore:
1215
1216 ==================
1217 ⁣  Semaphore
1218 ==================
1219
1220 .. autodoxyclass:: simgrid::s4u::Semaphore
1221
1222
1223 Basic management
1224 ----------------
1225
1226    .. tabs::
1227
1228       .. group-tab:: C++
1229
1230          .. code-block:: C++
1231
1232             #include <simgrid/s4u/Semaphore.hpp>
1233
1234          .. doxygentypedef:: SemaphorePtr
1235          .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
1236          .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
1237          .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
1238
1239       .. group-tab:: C
1240
1241          .. code-block:: C
1242
1243             #include <simgrid/semaphore.h>
1244
1245          .. doxygentypedef:: sg_sem_t
1246          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
1247
1248             Pointer to a constant semaphore object.
1249
1250          .. autodoxymethod:: sg_sem_init(int initial_value)
1251          .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
1252
1253 Locking
1254 -------
1255
1256    .. tabs::
1257
1258       .. group-tab:: C++
1259
1260          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
1261          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
1262          .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity()
1263          .. autodoxymethod:: simgrid::s4u::Semaphore::release()
1264          .. autodoxymethod:: simgrid::s4u::Semaphore::would_block()
1265
1266       .. group-tab:: C
1267
1268          .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
1269          .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
1270          .. autodoxymethod:: sg_sem_get_capacity(sg_sem_t sem)
1271          .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
1272          .. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)
1273
1274 Python API Reference
1275 ********************
1276
1277 The Python API is automatically generated with pybind11. It closely mimicks the C++
1278 API, to which you should refer for more information.
1279
1280 ==========
1281 this_actor
1282 ==========
1283
1284 .. automodule:: simgrid.this_actor
1285    :members:
1286
1287 ==========
1288 Class Comm
1289 ==========
1290
1291 .. autoclass:: simgrid.Comm
1292    :members:
1293
1294 ==========
1295 Class Exec
1296 ==========
1297
1298 .. autoclass:: simgrid.Exec
1299    :members:
1300
1301 ==========
1302 Class Host
1303 ==========
1304
1305 .. autoclass:: simgrid.Host
1306    :members:
1307
1308 =============
1309 Class Mailbox
1310 =============
1311
1312 .. autoclass:: simgrid.Mailbox
1313    :members:
1314
1315 .. |hr| raw:: html
1316
1317    <hr />