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 the way to go for long-term
  24 projects. It is feature complete, but may still evolve slightly in
  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 rendezvous 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 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 rendezvous, 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 consuming 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 is 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 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/cpp/comm-waitall/s4u-comm-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/cpp/comm-waitall/s4u-comm-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 rendezvous 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 helps
 236 senders and receivers to find each other. 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 mailboxes you are subscribed to.
 266
 267 The mailboxes are not located on the network, and you can access
 268 them without any latency. The network delays 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 tool 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 out 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:`put() <simgrid::s4u::Mailbox::put()>` 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 are 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 an on_exit callback.
 336
 337 ===============================
 338 Communicating without Mailboxes
 339 ===============================
 340
 341 Sometimes you don't want to simulate communications between actors as
 342 allowed by mailboxes, but you want to create a direct communication
 343 between two arbitrary hosts. This can arise when you write a
 344 high-level model of a centralized scheduler, or when you model direct
 345 communications such as one-sided communications in MPI or remote
 346 memory direct access in PGAS.
 347
 348 For that, :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`
 349 simulates a direct communication between the two specified hosts. No
 350 mailbox is used, and there is no rendezvous between actors. You can
 351 freely mix such direct communications and rendezvous-based
 352 communications. Alternatively, :cpp:func:`Comm::sendto_init()
 353 <simgrid::s4u::Comm::sendto_init()>` and
 354 :cpp:func:`Comm::sendto_async() <simgrid::s4u::Comm::sendto_async()>`
 355 create asynchronous direct communications.
 356
 357 .. _s4u_raii:
 358
 359 Memory Management
 360 *****************
 361
 362 For sake of simplicity, we use `RAII
 363 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 364 for many classes in S4U. This is an idiom where resources are automatically
 365 managed through the context. Provided that you never manipulate
 366 objects of type Foo directly but always FooPtr references (which are
 367 defined as `boost::intrusive_ptr
 368 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 369 <Foo>), you will never have to explicitly release the resource that
 370 you use nor to free the memory of unused objects.
 371 Here is a little example:
 372
 373 .. code-block:: cpp
 374
 375    void myFunc()
 376    {
 377      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 378
 379      mutex->lock();   // use the mutex as a simple reference
 380      //  bla bla
 381      mutex->unlock();
 382
 383    } // The mutex gets automatically freed because the only existing reference gets out of scope
 384
 385 Note that Mailboxes, Hosts, and Links are not handled through smart
 386 pointers (yet?). This means that it is currently impossible to destroy a
 387 mailbox or a link. You can still destroy a host (but probably
 388 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 389
 390 .. THE EXAMPLES
 391
 392 .. include:: ../../examples/README.rst
 393
 394 API Reference
 395 *************
 396
 397 .. _API_s4u_simulation_object:
 398
 399 ==================
 400 Simulation objects
 401 ==================
 402
 403 .. _API_s4u_Actor:
 404
 405 ==============
 406 ⁣  class Actor
 407 ==============
 408
 409 .. tabs::
 410
 411    .. group-tab:: C++
 412
 413       .. doxygenclass:: simgrid::s4u::Actor
 414
 415       .. doxygentypedef:: aid_t
 416
 417
 418    .. group-tab:: Python
 419
 420       .. autoclass:: simgrid.Actor
 421
 422 Basic management
 423 ----------------
 424
 425 .. tabs::
 426
 427    .. group-tab:: C++
 428
 429       .. code:: C++
 430
 431          #include <simgrid/s4u/Actor.hpp>
 432
 433       .. doxygentypedef:: ActorPtr
 434
 435    .. group-tab:: Python
 436
 437       .. code:: Python
 438
 439          from simgrid import Actor
 440
 441    .. group-tab:: C
 442
 443       .. code:: C
 444
 445          #include <simgrid/actor.h>
 446
 447       .. doxygentypedef:: sg_actor_t
 448       .. doxygentypedef:: const_sg_actor_t
 449       .. doxygenfunction:: sg_actor_ref
 450       .. doxygenfunction:: sg_actor_unref
 451
 452
 453 Creating actors
 454 ---------------
 455
 456 .. tabs::
 457
 458    .. group-tab:: C++
 459
 460       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 461       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 462       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 463       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 464
 465       .. doxygenfunction:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 466       .. doxygenfunction:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 467       .. doxygenfunction:: simgrid::s4u::Actor::set_stacksize
 468
 469    .. group-tab:: Python
 470
 471       .. automethod:: simgrid.Actor.create
 472
 473    .. group-tab:: C
 474
 475       .. doxygenfunction:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, char *const *argv)
 476       .. doxygenfunction:: sg_actor_init(const char *name, sg_host_t host)
 477       .. doxygenfunction:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char *const *argv)
 478       .. doxygenfunction:: sg_actor_set_stacksize
 479
 480       .. doxygenfunction:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 481       .. doxygenfunction:: sg_actor_detach()
 482
 483 Retrieving actors
 484 -----------------
 485
 486 .. tabs::
 487
 488    .. group-tab:: C++
 489
 490       .. doxygenfunction:: simgrid::s4u::Actor::by_pid(aid_t pid)
 491       .. doxygenfunction:: simgrid::s4u::Actor::self()
 492
 493    .. group-tab:: Python
 494
 495       .. automethod:: simgrid.Actor.by_pid
 496       .. automethod:: simgrid.Actor.self
 497
 498    .. group-tab:: C
 499
 500       .. doxygenfunction:: sg_actor_by_pid(aid_t pid)
 501       .. doxygenfunction:: sg_actor_self()
 502
 503 Querying info
 504 -------------
 505
 506 .. tabs::
 507
 508    .. group-tab:: C++
 509
 510       .. doxygenfunction:: simgrid::s4u::Actor::get_cname
 511       .. doxygenfunction:: simgrid::s4u::Actor::get_name
 512       .. doxygenfunction:: simgrid::s4u::Actor::get_pid
 513       .. doxygenfunction:: simgrid::s4u::Actor::get_ppid
 514       .. doxygenfunction:: simgrid::s4u::Actor::get_properties() const
 515       .. doxygenfunction:: simgrid::s4u::Actor::get_property(const std::string &key) const
 516       .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 517
 518       .. doxygenfunction:: simgrid::s4u::Actor::get_host
 519       .. doxygenfunction:: simgrid::s4u::Actor::set_host
 520
 521       .. doxygenfunction:: simgrid::s4u::Actor::get_refcount
 522       .. doxygenfunction:: simgrid::s4u::Actor::get_impl
 523
 524    .. group-tab:: Python
 525
 526       .. autoattribute:: simgrid.Actor.name
 527       .. autoattribute:: simgrid.Actor.host
 528       .. autoattribute:: simgrid.Actor.pid
 529       .. autoattribute:: simgrid.Actor.ppid
 530
 531    .. group-tab:: C
 532
 533       .. doxygenfunction:: sg_actor_get_name(const_sg_actor_t actor)
 534       .. doxygenfunction:: sg_actor_get_pid(const_sg_actor_t actor)
 535       .. doxygenfunction:: sg_actor_get_ppid(const_sg_actor_t actor)
 536       .. doxygenfunction:: sg_actor_get_properties(const_sg_actor_t actor)
 537       .. doxygenfunction:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 538
 539       .. doxygenfunction:: sg_actor_get_host(const_sg_actor_t actor)
 540       .. doxygenfunction:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 541
 542       .. doxygenfunction:: sg_actor_get_data(const_sg_actor_t actor)
 543       .. doxygenfunction:: sg_actor_set_data(sg_actor_t actor, void *userdata)
 544
 545 Suspending and resuming actors
 546 ------------------------------
 547
 548 .. tabs::
 549
 550    .. group-tab:: C++
 551
 552       .. doxygenfunction:: simgrid::s4u::Actor::suspend()
 553       .. doxygenfunction:: simgrid::s4u::Actor::resume()
 554       .. doxygenfunction:: simgrid::s4u::Actor::is_suspended
 555
 556    .. group-tab:: Python
 557
 558       .. automethod:: simgrid.Actor.resume
 559       .. automethod:: simgrid.Actor.suspend
 560       .. automethod:: simgrid.Actor.is_suspended
 561
 562    .. group-tab:: C
 563
 564       .. doxygenfunction:: sg_actor_suspend(sg_actor_t actor)
 565       .. doxygenfunction:: sg_actor_resume(sg_actor_t actor)
 566       .. doxygenfunction:: sg_actor_is_suspended(const_sg_actor_t actor)
 567
 568 Specifying when actors should terminate
 569 ---------------------------------------
 570
 571 .. tabs::
 572
 573    .. group-tab:: C++
 574
 575       .. doxygenfunction:: simgrid::s4u::Actor::kill()
 576       .. doxygenfunction:: simgrid::s4u::Actor::kill_all()
 577       .. doxygenfunction:: simgrid::s4u::Actor::set_kill_time(double time)
 578       .. doxygenfunction:: simgrid::s4u::Actor::get_kill_time
 579
 580       .. doxygenfunction:: simgrid::s4u::Actor::restart()
 581       .. doxygenfunction:: simgrid::s4u::Actor::daemonize()
 582       .. doxygenfunction:: simgrid::s4u::Actor::is_daemon
 583
 584    .. group-tab:: Python
 585
 586       .. automethod:: simgrid.Actor.kill
 587       .. automethod:: simgrid.Actor.kill_all
 588
 589       .. automethod:: simgrid.Actor.daemonize
 590       .. automethod:: simgrid.Actor.is_daemon
 591
 592    .. group-tab:: C
 593
 594       .. doxygenfunction:: sg_actor_kill(sg_actor_t actor)
 595       .. doxygenfunction:: sg_actor_kill_all()
 596       .. doxygenfunction:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 597
 598       .. doxygenfunction:: sg_actor_restart(sg_actor_t actor)
 599       .. doxygenfunction:: sg_actor_daemonize(sg_actor_t actor)
 600       .. doxygenfunction:: sg_actor_is_daemon
 601
 602 .. _API_s4u_Actor_end:
 603
 604 Reacting to the end of actors
 605 -----------------------------
 606
 607 .. tabs::
 608
 609    .. group-tab:: C++
 610
 611       .. doxygenfunction:: simgrid::s4u::Actor::on_exit
 612       .. doxygenfunction:: simgrid::s4u::Actor::join() const
 613       .. doxygenfunction:: simgrid::s4u::Actor::join(double timeout) const
 614       .. doxygenfunction:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 615
 616    .. group-tab:: Python
 617
 618       .. automethod:: simgrid.Actor.join
 619
 620    .. group-tab:: C
 621
 622       .. doxygenfunction:: sg_actor_on_exit
 623       .. doxygenfunction:: sg_actor_join(const_sg_actor_t actor, double timeout)
 624       .. doxygenfunction:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 625
 626 Signals
 627 -------
 628
 629 .. tabs::
 630
 631    .. group-tab:: C++
 632
 633       .. doxygenvariable:: simgrid::s4u::Actor::on_creation
 634       .. doxygenvariable:: simgrid::s4u::Actor::on_suspend
 635       .. doxygenvariable:: simgrid::s4u::Actor::on_host_change
 636       .. doxygenvariable:: simgrid::s4u::Actor::on_resume
 637       .. doxygenvariable:: simgrid::s4u::Actor::on_sleep
 638       .. doxygenvariable:: simgrid::s4u::Actor::on_wake_up
 639       .. doxygenvariable:: simgrid::s4u::Actor::on_termination
 640       .. doxygenvariable:: simgrid::s4u::Actor::on_destruction
 641
 642 .. _API_s4u_this_actor:
 643
 644 ====================
 645 ⁣  The current actor
 646 ====================
 647
 648 These functions can be used in your user code to interact with the actor
 649 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 650 Using these functions can greatly improve the code readability.
 651
 652 Querying info
 653 -------------
 654
 655 .. tabs::
 656
 657    .. group-tab:: C++
 658
 659       .. doxygenfunction:: simgrid::s4u::this_actor::get_cname()
 660       .. doxygenfunction:: simgrid::s4u::this_actor::get_name()
 661       .. doxygenfunction:: simgrid::s4u::this_actor::get_pid()
 662       .. doxygenfunction:: simgrid::s4u::this_actor::get_ppid()
 663       .. doxygenfunction:: simgrid::s4u::this_actor::is_maestro()
 664
 665       .. doxygenfunction:: simgrid::s4u::this_actor::get_host()
 666       .. doxygenfunction:: simgrid::s4u::this_actor::set_host(Host *new_host)
 667
 668    .. group-tab:: Python
 669
 670       .. autofunction:: simgrid.this_actor.get_host
 671       .. autofunction:: simgrid.this_actor.set_host
 672
 673    .. group-tab:: C
 674
 675       .. doxygenfunction:: sg_actor_self_get_data()
 676       .. doxygenfunction:: sg_actor_self_set_data(void *data)
 677       .. doxygenfunction:: sg_actor_self_get_name()
 678       .. doxygenfunction:: sg_actor_self_get_pid()
 679       .. doxygenfunction:: sg_actor_self_get_ppid()
 680       .. doxygenfunction:: sg_host_self()
 681       .. doxygenfunction:: sg_host_self_get_name()
 682
 683 Suspending and resuming
 684 -----------------------
 685
 686 .. tabs::
 687
 688    .. group-tab:: C++
 689
 690       .. doxygenfunction:: simgrid::s4u::this_actor::suspend()
 691       .. doxygenfunction:: simgrid::s4u::this_actor::yield()
 692
 693    .. group-tab:: Python
 694
 695       .. autofunction:: simgrid.this_actor.suspend
 696       .. autofunction:: simgrid.this_actor.yield_
 697
 698    .. group-tab:: C
 699
 700       .. doxygenfunction:: sg_actor_yield()
 701
 702 Logging messages
 703 ----------------
 704
 705 .. tabs::
 706
 707    .. group-tab:: Python
 708
 709        .. autofunction:: simgrid.this_actor.info
 710        .. autofunction:: simgrid.this_actor.error
 711
 712 Sleeping
 713 --------
 714
 715 .. tabs::
 716
 717    .. group-tab:: C++
 718
 719       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(double duration)
 720       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
 721       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
 722       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
 723
 724    .. group-tab:: Python
 725
 726       .. autofunction:: simgrid.this_actor.sleep_for
 727       .. autofunction:: simgrid.this_actor.sleep_until
 728
 729    .. group-tab:: C
 730
 731       .. doxygenfunction:: sg_actor_sleep_for(double duration)
 732
 733 Simulating executions
 734 ---------------------
 735
 736 Simulate the execution of some code on this actor. You can either simulate
 737 parallel or sequential code and you can either block upon the termination of
 738 the execution, or start an asynchronous activity.
 739
 740 .. tabs::
 741
 742    .. group-tab:: C++
 743
 744       .. doxygenfunction:: simgrid::s4u::this_actor::exec_async
 745       .. doxygenfunction:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 746       .. doxygenfunction:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
 747       .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop)
 748       .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop, double priority)
 749       .. doxygenfunction:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 750
 751    .. group-tab:: Python
 752
 753       .. autofunction:: simgrid.this_actor.exec_init
 754       .. autofunction:: simgrid.this_actor.execute
 755
 756    .. group-tab:: C
 757
 758       .. doxygenfunction:: sg_actor_execute(double flops)
 759       .. doxygenfunction:: sg_actor_execute_with_priority(double flops, double priority)
 760       .. doxygenfunction:: sg_actor_exec_init(double computation_amount)
 761       .. doxygenfunction:: sg_actor_exec_async(double computation_amount)
 762       .. doxygenfunction:: sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount, double* bytes_amount);
 763
 764 Exiting
 765 -------
 766
 767 .. tabs::
 768
 769    .. group-tab:: C++
 770
 771       .. doxygenfunction:: simgrid::s4u::this_actor::exit()
 772       .. doxygenfunction:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 773
 774    .. group-tab:: Python
 775
 776       .. autofunction:: simgrid.this_actor.exit
 777       .. autofunction:: simgrid.this_actor.on_exit
 778
 779    .. group-tab:: c
 780
 781       See also :cpp:func:`sg_actor_on_exit`.
 782
 783       .. doxygenfunction:: sg_actor_exit
 784
 785 .. _API_s4u_Engine:
 786
 787 ====================
 788 ⁣  Simulation Engine
 789 ====================
 790
 791 .. tabs::
 792
 793    .. group-tab:: C++
 794
 795       .. doxygenclass:: simgrid::s4u::Engine
 796
 797    .. group-tab:: Python
 798
 799       .. autoclass:: simgrid.Engine
 800
 801 Initialization
 802 --------------
 803
 804 .. tabs::
 805
 806    .. group-tab:: C++
 807
 808       .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 809       .. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
 810       .. doxygenfunction:: simgrid::s4u::Engine::shutdown()
 811       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
 812       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
 813       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
 814       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
 815       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
 816
 817       .. doxygenfunction:: simgrid::s4u::Engine::load_deployment
 818       .. doxygenfunction:: simgrid::s4u::Engine::load_platform
 819       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name)
 820       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 821       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
 822       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
 823
 824       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
 825       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
 826       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
 827
 828    .. group-tab:: Python
 829
 830        .. automethod:: simgrid.Engine.load_deployment
 831        .. automethod:: simgrid.Engine.load_platform
 832        .. automethod:: simgrid.Engine.register_actor
 833
 834    .. group-tab:: C
 835
 836       .. doxygenfunction:: simgrid_init
 837
 838       .. doxygenfunction:: simgrid_load_deployment
 839       .. doxygenfunction:: simgrid_load_platform
 840       .. doxygenfunction:: simgrid_register_default
 841       .. doxygenfunction:: simgrid_register_function
 842
 843 Run the simulation
 844 ------------------
 845
 846 .. tabs::
 847
 848    .. group-tab:: C++
 849
 850       .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
 851       .. doxygenfunction:: simgrid::s4u::Engine::run
 852       .. doxygenfunction:: simgrid::s4u::Engine::run_until
 853
 854    .. group-tab:: Python
 855
 856       .. automethod:: simgrid.Engine.get_clock
 857       .. automethod:: simgrid.Engine.run
 858       .. automethod:: simgrid.Engine.run_until
 859
 860    .. group-tab:: C
 861
 862       .. doxygenfunction:: simgrid_get_clock
 863       .. doxygenfunction:: simgrid_run
 864       .. doxygenfunction:: simgrid_run_until
 865
 866 Retrieving actors
 867 -----------------
 868
 869 .. tabs::
 870
 871    .. group-tab:: C++
 872
 873       .. doxygenfunction:: simgrid::s4u::Engine::get_actor_count
 874       .. doxygenfunction:: simgrid::s4u::Engine::get_all_actors
 875       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_actors
 876
 877    .. group-tab:: C
 878
 879       .. doxygenfunction:: sg_actor_count()
 880
 881 Retrieving hosts
 882 ----------------
 883
 884 .. tabs::
 885
 886    .. group-tab:: C++
 887
 888       .. doxygenfunction:: simgrid::s4u::Engine::get_all_hosts
 889       .. doxygenfunction:: simgrid::s4u::Engine::get_host_count
 890       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_hosts
 891       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name
 892       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name_or_null
 893
 894    .. group-tab:: Python
 895
 896       .. automethod:: simgrid.Engine.get_all_hosts
 897
 898    .. group-tab:: C
 899
 900       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 901
 902 Retrieving links
 903 ----------------
 904
 905 .. tabs::
 906
 907    .. group-tab:: C++
 908
 909       .. doxygenfunction:: simgrid::s4u::Engine::get_all_links
 910       .. doxygenfunction:: simgrid::s4u::Engine::get_link_count
 911       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_links
 912       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name
 913       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name_or_null
 914
 915 Interacting with the routing
 916 ----------------------------
 917
 918 .. tabs::
 919
 920    .. group-tab:: C++
 921
 922       .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
 923       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
 924       .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
 925       .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
 926       .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
 927       .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
 928       .. doxygenfunction:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 929
 930 Signals
 931 -------
 932
 933 .. tabs::
 934
 935    .. group-tab:: C++
 936
 937       .. doxygenvariable:: simgrid::s4u::Engine::on_deadlock
 938       .. doxygenvariable:: simgrid::s4u::Engine::on_platform_created
 939       .. doxygenvariable:: simgrid::s4u::Engine::on_platform_creation
 940       .. doxygenvariable:: simgrid::s4u::Engine::on_simulation_end
 941       .. doxygenvariable:: simgrid::s4u::Engine::on_time_advance
 942
 943 .. _API_s4u_Mailbox:
 944
 945 ================
 946 ⁣  class Mailbox
 947 ================
 948
 949 .. tabs::
 950
 951    .. group-tab:: C++
 952
 953       .. doxygenclass:: simgrid::s4u::Mailbox
 954
 955    .. group-tab:: Python
 956
 957       .. autoclass:: simgrid.Mailbox
 958
 959 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 960
 961 Basic management
 962 ----------------
 963
 964 .. tabs::
 965
 966    .. group-tab:: C++
 967
 968       .. code-block:: C++
 969
 970          #include <simgrid/s4u/Mailbox.hpp>
 971
 972       Note that there is no MailboxPtr type and that you cannot use the RAII
 973       idiom on mailboxes because they are internal objects to the simulation
 974       engine. Once created, there is no way to destroy a mailbox before the end
 975       of the simulation.
 976
 977       .. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
 978
 979    .. group-tab:: Python
 980
 981       .. code-block:: C++
 982
 983          #include <simgrid/mailbox.h>
 984
 985       .. automethod:: simgrid.Mailbox.by_name
 986
 987    .. group-tab:: C
 988
 989       .. code-block:: C
 990
 991          #include <simgrid/s4u/mailbox.h>
 992
 993       .. doxygentypedef:: sg_mailbox_t
 994       .. doxygentypedef:: const_sg_mailbox_t
 995
 996       .. doxygenfunction:: sg_mailbox_by_name(const char *alias)
 997
 998 Querying info
 999 -------------
1000
1001 .. tabs::
1002
1003    .. group-tab:: C++
1004
1005       .. doxygenfunction:: simgrid::s4u::Mailbox::get_cname
1006       .. doxygenfunction:: simgrid::s4u::Mailbox::get_name
1007
1008    .. group-tab:: Python
1009
1010       .. autoattribute:: simgrid.Mailbox.name
1011
1012 Sending data
1013 ------------
1014
1015 .. tabs::
1016
1017    .. group-tab:: C++
1018
1019       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
1020       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
1021       .. doxygenfunction:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
1022       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init()
1023       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
1024
1025    .. group-tab:: Python
1026
1027       .. automethod:: simgrid.Mailbox.put
1028       .. automethod:: simgrid.Mailbox.put_async
1029
1030    .. group-tab:: C
1031
1032       .. doxygenfunction:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1033       .. doxygenfunction:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1034       .. doxygenfunction:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1035
1036
1037 Receiving data
1038 --------------
1039
1040 .. tabs::
1041
1042    .. group-tab:: C++
1043
1044       .. doxygenfunction:: simgrid::s4u::Mailbox::empty
1045       .. doxygenfunction:: simgrid::s4u::Mailbox::front
1046       .. doxygenfunction:: simgrid::s4u::Mailbox::get()
1047       .. doxygenfunction:: simgrid::s4u::Mailbox::get(double timeout)
1048       .. doxygenfunction:: simgrid::s4u::Mailbox::get_async(T **data)
1049       .. doxygenfunction:: simgrid::s4u::Mailbox::get_init()
1050       .. doxygenfunction:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
1051       .. doxygenfunction:: simgrid::s4u::Mailbox::listen
1052       .. doxygenfunction:: simgrid::s4u::Mailbox::ready
1053
1054    .. group-tab:: Python
1055
1056        .. automethod:: simgrid.Mailbox.get
1057        .. automethod:: simgrid.Mailbox.get_async
1058
1059    .. group-tab:: C
1060
1061       .. doxygenfunction:: sg_mailbox_get(sg_mailbox_t mailbox)
1062       .. doxygenfunction:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1063       .. doxygenfunction:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1064       .. doxygenfunction:: sg_mailbox_listen(const char *alias)
1065
1066 Receiving actor
1067 ---------------
1068
1069 See :ref:`s4u_receiving_actor`.
1070
1071 .. tabs::
1072
1073    .. group-tab:: C++
1074
1075       .. doxygenfunction:: simgrid::s4u::Mailbox::get_receiver
1076       .. doxygenfunction:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1077
1078    .. group-tab:: C
1079
1080       .. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
1081
1082 .. _API_s4u_Resource:
1083
1084 =========
1085 Resources
1086 =========
1087
1088 .. _API_s4u_Disk:
1089
1090 =============
1091 ⁣  class Disk
1092 =============
1093
1094 .. tabs::
1095
1096    .. group-tab:: C++
1097
1098       .. doxygenclass:: simgrid::s4u::Disk
1099
1100    .. group-tab:: Python
1101
1102       .. autoclass:: simgrid.Disk
1103
1104 Basic management
1105 ----------------
1106
1107 .. tabs::
1108
1109    .. group-tab:: C++
1110
1111       .. code-block:: C++
1112
1113          #include <simgrid/s4u/Disk.hpp>
1114
1115       Note that there is no DiskPtr type and that you cannot use the RAII
1116       idiom on disks because SimGrid does not allow (yet) to create nor
1117       destroy resources once the simulation is started.
1118
1119       .. doxygenfunction:: simgrid::s4u::Disk::seal()
1120
1121    .. group-tab:: Python
1122
1123       .. code:: Python
1124
1125          from simgrid import Disk
1126
1127       .. automethod:: simgrid.Disk.seal
1128
1129
1130 Querying info
1131 -------------
1132
1133 .. tabs::
1134
1135    .. group-tab:: C++
1136
1137       .. doxygenfunction:: simgrid::s4u::Disk::get_cname() const
1138       .. doxygenfunction:: simgrid::s4u::Disk::get_host() const
1139       .. doxygenfunction:: simgrid::s4u::Disk::get_name() const
1140       .. doxygenfunction:: simgrid::s4u::Disk::get_properties() const
1141       .. doxygenfunction:: simgrid::s4u::Disk::get_property(const std::string &key) const
1142       .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
1143       .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
1144       .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1145       .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1146
1147    .. group-tab:: Python
1148
1149       .. autoattribute:: simgrid.Disk.name
1150       .. automethod:: simgrid.Disk.set_sharing_policy
1151
1152 I/O operations
1153 --------------
1154
1155 .. tabs::
1156
1157    .. group-tab:: C++
1158
1159       .. doxygenfunction:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type) const
1160       .. doxygenfunction:: simgrid::s4u::Disk::read(sg_size_t size) const
1161       .. doxygenfunction:: simgrid::s4u::Disk::read_async(sg_size_t size) const
1162       .. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
1163       .. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
1164
1165    .. group-tab:: Python
1166
1167       .. automethod:: simgrid.Disk.read
1168       .. automethod:: simgrid.Disk.read_async
1169       .. automethod:: simgrid.Disk.write
1170       .. automethod:: simgrid.Disk.write_async
1171
1172 Signals
1173 -------
1174
1175 .. tabs::
1176
1177    .. group-tab:: C++
1178
1179       .. doxygenvariable:: simgrid::s4u::Disk::on_creation
1180       .. doxygenvariable:: simgrid::s4u::Disk::on_destruction
1181       .. doxygenvariable:: simgrid::s4u::Disk::on_state_change
1182
1183
1184 .. _API_s4u_Host:
1185
1186 =============
1187 ⁣  class Host
1188 =============
1189
1190 .. tabs::
1191
1192    .. group-tab:: C++
1193
1194       .. doxygenclass:: simgrid::s4u::Host
1195
1196    .. group-tab:: Python
1197
1198       .. autoclass:: simgrid.Host
1199
1200 Basic management
1201 ----------------
1202
1203 .. tabs::
1204
1205    .. group-tab:: C++
1206
1207       .. code-block:: C++
1208
1209          #include <simgrid/s4u/Host.hpp>
1210
1211       Note that there is no HostPtr type, and that you cannot use the RAII
1212       idiom on hosts because SimGrid does not allow (yet) to create nor
1213       destroy resources once the simulation is started.
1214
1215       .. doxygenfunction:: simgrid::s4u::Host::destroy()
1216       .. doxygenfunction:: simgrid::s4u::Host::seal()
1217
1218    .. group-tab:: Python
1219
1220       .. code:: Python
1221
1222          from simgrid import Host
1223
1224       .. automethod:: simgrid.Host.seal
1225
1226    .. group-tab:: C
1227
1228       .. code:: C
1229
1230          #include <simgrid/host.h>
1231
1232       .. doxygentypedef:: sg_host_t
1233       .. cpp:type:: const s4u_Host* const_sg_host_t
1234
1235          Pointer to a constant host object.
1236
1237 Retrieving hosts
1238 ----------------
1239
1240 .. tabs::
1241
1242    .. group-tab:: C++
1243
1244       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1245
1246       .. doxygenfunction:: simgrid::s4u::Host::by_name(const std::string &name)
1247       .. doxygenfunction:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1248       .. doxygenfunction:: simgrid::s4u::Host::current()
1249
1250    .. group-tab:: Python
1251
1252       See also :py:func:`simgrid.Engine.get_all_hosts`.
1253
1254       .. automethod:: simgrid.Host.by_name
1255       .. automethod:: simgrid.Host.current
1256
1257    .. group-tab:: C
1258
1259       .. doxygenfunction:: sg_host_by_name(const char *name)
1260       .. doxygenfunction:: sg_host_count()
1261       .. doxygenfunction:: sg_host_list()
1262
1263 Modifying characteristics
1264 -------------------------
1265
1266 .. tabs::
1267
1268    .. group-tab:: C++
1269
1270       .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count)
1271       .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords)
1272       .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1273
1274    .. group-tab:: Python
1275
1276       .. automethod:: simgrid.Host.set_core_count
1277       .. automethod:: simgrid.Host.set_coordinates
1278       .. automethod:: simgrid.Host.set_sharing_policy
1279
1280 Querying info
1281 -------------
1282
1283 .. tabs::
1284
1285    .. group-tab:: C++
1286
1287       .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1288       .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1289       .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1290       .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1291       .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1292       .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1293
1294    .. group-tab:: Python
1295
1296       .. autoattribute:: simgrid.Host.name
1297       .. autoattribute:: simgrid.Host.load
1298       .. autoattribute:: simgrid.Host.pstate
1299       .. autoattribute:: simgrid.Host.speed
1300
1301    .. group-tab:: C
1302
1303       .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1304       .. doxygenfunction:: sg_host_dump(const_sg_host_t ws)
1305       .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1306       .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1307       .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1308
1309 User data and properties
1310 ------------------------
1311
1312 .. tabs::
1313
1314    .. group-tab:: C++
1315
1316       .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1317       .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1318       .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1319       .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1320
1321    .. group-tab:: C
1322
1323       .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1324       .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1325       .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1326       .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1327       .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1328
1329 Retrieving components
1330 ---------------------
1331
1332 .. tabs::
1333
1334    .. group-tab:: C++
1335
1336       .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1337       .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1338       .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1339       .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1340       .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1341
1342    .. group-tab:: Python
1343
1344       .. automethod:: simgrid.Host.get_disks
1345
1346    .. group-tab:: C
1347
1348       .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1349
1350 On/Off
1351 ------
1352
1353 .. tabs::
1354
1355    .. group-tab:: C++
1356
1357       .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1358       .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1359       .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1360
1361    .. group-tab:: C
1362
1363       .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1364       .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1365       .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1366
1367 DVFS
1368 ----
1369
1370 .. tabs::
1371
1372    .. group-tab:: C++
1373
1374       .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1375       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1376       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(unsigned long pstate_index) const
1377       .. doxygenfunction:: simgrid::s4u::Host::set_pstate(unsigned long pstate_index)
1378       .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1379       .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1380
1381    .. group-tab:: Python
1382
1383       .. automethod:: simgrid.Host.get_pstate_count
1384       .. automethod:: simgrid.Host.get_pstate_speed
1385
1386    .. group-tab:: C
1387
1388       .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1389       .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1390       .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1391       .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
1392       .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, unsigned long pstate)
1393
1394 Execution
1395 ---------
1396
1397 .. tabs::
1398
1399    .. group-tab:: C++
1400
1401       .. doxygenfunction:: simgrid::s4u::Host::exec_async
1402       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1403       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1404
1405 Platform and routing
1406 --------------------
1407
1408 You can also start direct communications between two arbitrary hosts
1409 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1410
1411 .. tabs::
1412
1413    .. group-tab:: C++
1414
1415       .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1416       .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1417       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1418       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
1419       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
1420       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
1421
1422    .. group-tab:: Python
1423
1424       .. automethod:: simgrid.Host.get_netpoint
1425       .. automethod:: simgrid.Host.create_disk
1426
1427    .. group-tab:: C
1428
1429       .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1430       .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1431       .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1432       .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1433
1434 Signals
1435 -------
1436
1437 .. tabs::
1438
1439    .. group-tab:: C++
1440
1441       .. doxygenvariable:: simgrid::s4u::Host::on_creation
1442       .. doxygenvariable:: simgrid::s4u::Host::on_destruction
1443       .. doxygenvariable:: simgrid::s4u::Host::on_speed_change
1444       .. doxygenvariable:: simgrid::s4u::Host::on_state_change
1445
1446 .. _API_s4u_Link:
1447
1448 =============
1449 ⁣  class Link
1450 =============
1451
1452 .. tabs::
1453
1454    .. group-tab:: C++
1455
1456       .. doxygenclass:: simgrid::s4u::Link
1457       .. doxygenclass:: simgrid::s4u::SplitDuplexLink
1458       .. doxygenclass:: simgrid::s4u::LinkInRoute
1459
1460
1461    .. group-tab:: Python
1462
1463       .. autoclass:: simgrid.Link
1464
1465 Basic management
1466 ----------------
1467
1468 .. tabs::
1469
1470    .. group-tab:: C++
1471
1472       .. code-block:: C++
1473
1474          #include <simgrid/s4u/Link.hpp>
1475
1476       Note that there is no LinkPtr type and that you cannot use the RAII
1477       idiom on hosts because SimGrid does not allow (yet) to create nor
1478       destroy resources once the simulation is started.
1479
1480       .. doxygenfunction:: simgrid::s4u::Link::seal()
1481
1482    .. group-tab:: Python
1483
1484       .. code:: Python
1485
1486          from simgrid import Link
1487
1488       .. automethod:: simgrid.Link.seal
1489
1490    .. group-tab:: C
1491
1492       .. code:: C
1493
1494          #include <simgrid/link.h>
1495
1496       .. doxygentypedef:: sg_link_t
1497       .. cpp:type:: const s4u_Link* const_sg_link_t
1498
1499          Pointer to a constant link object.
1500
1501 Retrieving links
1502 ----------------
1503
1504 .. tabs::
1505
1506    .. group-tab:: C++
1507
1508       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1509
1510       .. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
1511       .. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1512
1513    .. group-tab:: Python
1514
1515       .. autoattribute:: simgrid.Link.name
1516
1517    .. group-tab:: C
1518
1519       .. doxygenfunction:: sg_link_by_name(const char *name)
1520       .. doxygenfunction:: sg_link_count()
1521       .. doxygenfunction:: sg_link_list()
1522
1523 Querying info
1524 --------------
1525
1526 .. tabs::
1527
1528    .. group-tab:: C++
1529
1530       .. doxygenfunction:: simgrid::s4u::Link::get_bandwidth() const
1531       .. doxygenfunction:: simgrid::s4u::Link::get_cname() const
1532       .. doxygenfunction:: simgrid::s4u::Link::get_latency() const
1533       .. doxygenfunction:: simgrid::s4u::Link::get_name() const
1534       .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const
1535       .. doxygenfunction:: simgrid::s4u::Link::get_usage() const
1536       .. doxygenfunction:: simgrid::s4u::Link::is_used() const
1537
1538    .. group-tab:: C
1539
1540       .. doxygenfunction:: sg_link_get_bandwidth(const_sg_link_t link)
1541       .. doxygenfunction:: sg_link_get_latency(const_sg_link_t link)
1542       .. doxygenfunction:: sg_link_get_name(const_sg_link_t link)
1543       .. doxygenfunction:: sg_link_is_shared(const_sg_link_t link)
1544
1545 Modifying characteristics
1546 -------------------------
1547
1548 .. tabs::
1549
1550    .. group-tab:: C++
1551
1552       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
1553       .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
1554       .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value)
1555       .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit)
1556       .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {})
1557
1558    .. group-tab:: Python
1559
1560       .. automethod:: simgrid.Link.set_latency
1561       .. automethod:: simgrid.Link.set_concurrency_limit
1562       .. automethod:: simgrid.Link.set_sharing_policy
1563
1564    .. group-tab:: C
1565
1566       .. doxygenfunction:: sg_link_set_bandwidth(sg_link_t link, double value)
1567       .. doxygenfunction:: sg_link_set_latency(sg_link_t link, double value)
1568
1569 User data and properties
1570 ------------------------
1571
1572 .. tabs::
1573
1574    .. group-tab:: C++
1575
1576       .. doxygenfunction:: simgrid::s4u::Link::get_property(const std::string &key) const
1577       .. doxygenfunction:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1578
1579    .. group-tab:: C
1580
1581       .. doxygenfunction:: sg_link_get_data(const_sg_link_t link)
1582       .. doxygenfunction:: sg_link_set_data(sg_link_t link, void *data)
1583
1584 On/Off
1585 ------
1586
1587 .. tabs::
1588
1589    .. group-tab:: C++
1590
1591       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1592
1593       .. doxygenfunction:: simgrid::s4u::Link::is_on() const
1594       .. doxygenfunction:: simgrid::s4u::Link::turn_off()
1595       .. doxygenfunction:: simgrid::s4u::Link::turn_on()
1596
1597 Dynamic profiles
1598 ----------------
1599
1600 See :ref:`howto_churn` for more details.
1601
1602 .. tabs::
1603
1604    .. group-tab:: C++
1605
1606       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1607       .. doxygenfunction:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1608       .. doxygenfunction:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1609
1610 WIFI links
1611 ----------
1612
1613 .. tabs::
1614
1615    .. group-tab:: C++
1616
1617       .. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
1618
1619    .. group-tab:: Python
1620
1621       .. automethod:: simgrid.Link.set_host_wifi_rate
1622
1623 Signals
1624 -------
1625
1626 .. tabs::
1627
1628    .. group-tab:: C++
1629
1630       .. doxygenvariable:: simgrid::s4u::Link::on_bandwidth_change
1631       .. doxygenvariable:: simgrid::s4u::Link::on_communication_state_change
1632       .. doxygenvariable:: simgrid::s4u::Link::on_creation
1633       .. doxygenvariable:: simgrid::s4u::Link::on_destruction
1634       .. doxygenvariable:: simgrid::s4u::Link::on_state_change
1635
1636 .. _API_s4u_NetZone:
1637
1638 ================
1639 ⁣  class NetZone
1640 ================
1641
1642 .. tabs::
1643
1644    .. group-tab:: C++
1645
1646       .. doxygenclass:: simgrid::s4u::NetZone
1647
1648    .. group-tab:: Python
1649
1650       .. autoclass:: simgrid.NetZone
1651
1652 Basic management
1653 ----------------
1654
1655 .. tabs::
1656
1657    .. group-tab:: C++
1658
1659       .. code-block:: C++
1660
1661          #include <simgrid/s4u/NetZone.hpp>
1662
1663       Note that there is no NetZonePtr type and that you cannot use the RAII
1664       idiom on network zones because SimGrid does not allow (yet) to create nor
1665       destroy resources once the simulation is started.
1666
1667       .. doxygenfunction:: simgrid::s4u::NetZone::seal
1668
1669    .. group-tab:: Python
1670
1671       .. code:: Python
1672
1673          from simgrid import NetZone
1674
1675       .. automethod:: simgrid.NetZone.seal
1676
1677    .. group-tab:: C
1678
1679       .. code:: C
1680
1681          #include <simgrid/zone.h>
1682
1683       .. doxygentypedef:: sg_netzone_t
1684       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1685
1686          Pointer to a constant network zone object.
1687
1688 Retrieving zones
1689 ----------------
1690
1691 .. tabs::
1692
1693    .. group-tab:: C++
1694
1695       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1696       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1697       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1698
1699    .. group-tab:: C
1700
1701       .. doxygenfunction:: sg_zone_get_by_name(const char *name)
1702       .. doxygenfunction:: sg_zone_get_root()
1703
1704 Querying info
1705 --------------
1706
1707 .. tabs::
1708
1709    .. group-tab:: C++
1710
1711       .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
1712       .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
1713       .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint()
1714
1715    .. group-tab:: Python
1716
1717       .. autoattribute:: simgrid.NetZone.name
1718       .. automethod:: simgrid.NetZone.get_netpoint
1719
1720    .. group-tab:: C
1721
1722       .. doxygenfunction:: sg_zone_get_name(const_sg_netzone_t zone)
1723
1724 User data and properties
1725 ------------------------
1726
1727 .. tabs::
1728
1729    .. group-tab:: C++
1730
1731       .. doxygenfunction:: simgrid::s4u::NetZone::get_properties() const
1732       .. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1733       .. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1734
1735    .. group-tab:: Python
1736
1737       .. automethod:: simgrid.NetZone.set_property
1738
1739    .. group-tab:: C
1740
1741       .. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1742       .. doxygenfunction:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1743
1744 Retrieving components
1745 ---------------------
1746
1747 .. tabs::
1748
1749    .. group-tab:: C++
1750
1751       .. doxygenfunction:: simgrid::s4u::NetZone::get_all_hosts() const
1752       .. doxygenfunction:: simgrid::s4u::NetZone::get_host_count() const
1753
1754    .. group-tab:: C
1755
1756       .. doxygenfunction:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1757
1758 Routing data
1759 ------------
1760
1761 .. tabs::
1762
1763    .. group-tab:: C++
1764
1765       .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1766       .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1767       .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
1768       .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1769       .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
1770       .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent)
1771
1772    .. group-tab:: Python
1773
1774       .. automethod:: simgrid.NetZone.add_route
1775       .. automethod:: simgrid.NetZone.set_parent
1776
1777    .. group-tab:: C
1778
1779       .. doxygenfunction:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1780
1781 Signals
1782 -------
1783
1784 .. tabs::
1785
1786   .. group-tab:: C++
1787
1788      .. doxygenvariable:: simgrid::s4u::NetZone::on_creation
1789      .. doxygenvariable:: simgrid::s4u::NetZone::on_seal
1790
1791 Creating resources
1792 ------------------
1793
1794 Zones
1795 ^^^^^
1796 .. tabs::
1797
1798   .. group-tab:: C++
1799
1800      .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name)
1801      .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name)
1802      .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name)
1803      .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache)
1804      .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name)
1805      .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name)
1806      .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name)
1807      .. doxygenfunction:: simgrid::s4u::create_torus_zone
1808      .. doxygenfunction:: simgrid::s4u::create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
1809      .. doxygenfunction:: simgrid::s4u::create_dragonfly_zone(const std::string& name, const NetZone* parent, const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
1810
1811   .. group-tab:: Python
1812
1813      .. automethod:: simgrid.NetZone.create_full_zone
1814      .. automethod:: simgrid.NetZone.create_empty_zone
1815      .. automethod:: simgrid.NetZone.create_star_zone
1816      .. automethod:: simgrid.NetZone.create_dijkstra_zone
1817      .. automethod:: simgrid.NetZone.create_floyd_zone
1818      .. automethod:: simgrid.NetZone.create_vivaldi_zone
1819      .. automethod:: simgrid.NetZone.create_wifi_zone
1820      .. automethod:: simgrid.NetZone.create_torus_zone
1821      .. automethod:: simgrid.NetZone.create_fatTree_zone
1822      .. automethod:: simgrid.NetZone.create_dragonfly_zone
1823
1824 Hosts
1825 ^^^^^
1826
1827 .. tabs::
1828
1829   .. group-tab:: C++
1830
1831      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
1832      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed)
1833      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
1834      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed)
1835
1836   .. group-tab:: Python
1837
1838      .. automethod:: simgrid.NetZone.create_host
1839
1840 Links
1841 ^^^^^
1842
1843 .. tabs::
1844
1845   .. group-tab:: C++
1846
1847      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
1848      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth)
1849      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidthds)
1850      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth)
1851      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
1852      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
1853
1854   .. group-tab:: Python
1855
1856      .. automethod:: simgrid.NetZone.create_link
1857      .. automethod:: simgrid.NetZone.create_split_duplex_link
1858
1859 Router
1860 ^^^^^^
1861
1862 .. tabs::
1863
1864   .. group-tab:: C++
1865
1866      .. doxygenfunction:: simgrid::s4u::NetZone::create_router(const std::string& name)
1867
1868   .. group-tab:: Python
1869
1870      .. automethod:: simgrid.NetZone.create_router
1871
1872 .. _API_s4u_VirtualMachine:
1873
1874 =======================
1875 ⁣  class VirtualMachine
1876 =======================
1877
1878
1879 .. doxygenclass:: simgrid::s4u::VirtualMachine
1880
1881 Basic management
1882 ----------------
1883 .. tabs::
1884
1885    .. group-tab:: C++
1886
1887       .. code-block:: C++
1888
1889          #include <simgrid/s4u/VirtualMachine.hpp>
1890
1891       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1892       idiom on virtual machines. There is no good reason for that and should change in the future.
1893
1894    .. group-tab:: C
1895
1896       .. code:: C
1897
1898          #include <simgrid/vm.h>
1899
1900       .. doxygentypedef:: sg_vm_t
1901       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1902
1903          Pointer to a constant virtual machine object.
1904
1905 Creating VMs
1906 ------------
1907
1908 .. tabs::
1909
1910    .. group-tab:: C++
1911
1912       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount)
1913       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount, size_t ramsize)
1914       .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1915
1916    .. group-tab:: C
1917
1918       .. doxygenfunction:: sg_vm_create_core
1919       .. doxygenfunction:: sg_vm_create_multicore
1920       .. doxygenfunction:: sg_vm_destroy
1921
1922 Querying info
1923 --------------
1924
1925 .. tabs::
1926
1927    .. group-tab:: C++
1928
1929       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1930       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
1931       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
1932
1933       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1934       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1935       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1936
1937    .. group-tab:: C
1938
1939       .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
1940       .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
1941       .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1942
1943       .. doxygenfunction:: sg_vm_get_name
1944       .. doxygenfunction:: sg_vm_get_pm
1945       .. doxygenfunction:: sg_vm_is_created
1946       .. doxygenfunction:: sg_vm_is_running
1947       .. doxygenfunction:: sg_vm_is_suspended
1948
1949 Life cycle
1950 ----------
1951
1952 .. tabs::
1953
1954    .. group-tab:: C++
1955
1956       .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
1957       .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
1958       .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
1959       .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
1960
1961    .. group-tab:: C
1962
1963       .. doxygenfunction:: sg_vm_start
1964       .. doxygenfunction:: sg_vm_suspend
1965       .. doxygenfunction:: sg_vm_resume
1966       .. doxygenfunction:: sg_vm_shutdown
1967
1968 Signals
1969 -------
1970
1971 .. tabs::
1972
1973    .. group-tab:: C++
1974
1975       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_creation
1976       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_destruction
1977       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_end
1978       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_start
1979       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_resume
1980       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_shutdown
1981       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_start
1982       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_started
1983       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_suspend
1984
1985 .. _API_s4u_Activity:
1986
1987 ==========
1988 Activities
1989 ==========
1990
1991 ==============
1992 class Activity
1993 ==============
1994
1995 .. doxygenclass:: simgrid::s4u::Activity
1996
1997 **Known subclasses:**
1998 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1999 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
2000 :ref:`I/O <API_s4u_Io>` (started on and consuming disks).
2001 See also the :ref:`section on activities <s4u_Activities>` above.
2002
2003 Basic management
2004 ----------------
2005
2006 .. tabs::
2007
2008    .. group-tab:: C++
2009
2010       .. code-block:: C++
2011
2012          #include <simgrid/s4u/Activity.hpp>
2013
2014       .. doxygentypedef:: ActivityPtr
2015
2016 Querying info
2017 -------------
2018
2019 .. tabs::
2020
2021    .. group-tab:: C++
2022
2023       .. doxygenfunction:: simgrid::s4u::Activity::get_cname
2024       .. doxygenfunction:: simgrid::s4u::Activity::get_name
2025       .. doxygenfunction:: simgrid::s4u::Activity::get_remaining() const
2026       .. doxygenfunction:: simgrid::s4u::Activity::get_state() const
2027       .. doxygenfunction:: simgrid::s4u::Activity::set_remaining(double remains)
2028       .. doxygenfunction:: simgrid::s4u::Activity::set_state(Activity::State state)
2029
2030
2031 Activities life cycle
2032 ---------------------
2033
2034 .. tabs::
2035
2036    .. group-tab:: C++
2037
2038       .. doxygenfunction:: simgrid::s4u::Activity::start
2039       .. doxygenfunction:: simgrid::s4u::Activity::cancel
2040       .. doxygenfunction:: simgrid::s4u::Activity::test
2041       .. doxygenfunction:: simgrid::s4u::Activity::wait
2042       .. doxygenfunction:: simgrid::s4u::Activity::wait_for
2043       .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit)
2044       .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start()
2045
2046 Suspending and resuming an activity
2047 -----------------------------------
2048
2049 .. tabs::
2050
2051    .. group-tab:: C++
2052
2053       .. doxygenfunction:: simgrid::s4u::Activity::suspend
2054       .. doxygenfunction:: simgrid::s4u::Activity::resume
2055       .. doxygenfunction:: simgrid::s4u::Activity::is_suspended
2056
2057 .. _API_s4u_Comm:
2058
2059 =============
2060 ⁣  class Comm
2061 =============
2062
2063 .. tabs::
2064
2065    .. group-tab:: C++
2066
2067       .. doxygenclass:: simgrid::s4u::Comm
2068
2069    .. group-tab:: Python
2070
2071       .. autoclass:: simgrid.Comm
2072
2073 Basic management
2074 ----------------
2075
2076 .. tabs::
2077
2078    .. group-tab:: C++
2079
2080       .. code-block:: C++
2081
2082          #include <simgrid/s4u/Comm.hpp>
2083
2084       .. doxygentypedef:: CommPtr
2085
2086    .. group-tab:: Python
2087
2088       .. code:: Python
2089
2090          from simgrid import Comm
2091
2092    .. group-tab:: c
2093
2094       .. code:: c
2095
2096          #include <simgrid/comm.h>
2097
2098       .. doxygentypedef:: sg_comm_t
2099       .. doxygentypedef:: const_sg_comm_t
2100
2101 Querying info
2102 -------------
2103
2104 .. tabs::
2105
2106    .. group-tab:: C++
2107
2108       .. doxygenfunction:: simgrid::s4u::Comm::get_dst_data_size() const
2109       .. doxygenfunction:: simgrid::s4u::Comm::get_mailbox() const
2110       .. doxygenfunction:: simgrid::s4u::Comm::get_sender() const
2111       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff)
2112       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
2113       .. doxygenfunction:: simgrid::s4u::Comm::detach()
2114       .. doxygenfunction:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
2115       .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(uint64_t bytes)
2116       .. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
2117       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
2118       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
2119       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data_size(size_t size)
2120
2121 Life cycle
2122 ----------
2123
2124 Most communications are created using :ref:`s4u_mailbox`, but you can
2125 also start direct communications as shown below.
2126
2127 .. tabs::
2128
2129    .. group-tab:: C++
2130
2131       .. doxygenfunction:: simgrid::s4u::Comm::sendto
2132       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init()
2133       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init(Host *from, Host *to)
2134       .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
2135
2136       .. doxygenfunction:: simgrid::s4u::Comm::cancel
2137       .. doxygenfunction:: simgrid::s4u::Comm::start
2138       .. doxygenfunction:: simgrid::s4u::Comm::test
2139       .. doxygenfunction:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr >& comms)
2140       .. doxygenfunction:: simgrid::s4u::Comm::wait
2141       .. doxygenfunction:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr >& comms)
2142       .. doxygenfunction:: simgrid::s4u::Comm::wait_all_for(const std::vector< CommPtr >& comms, double timeout)
2143       .. doxygenfunction:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr >& comms)
2144       .. doxygenfunction:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr >& comms, double timeout)
2145       .. doxygenfunction:: simgrid::s4u::Comm::wait_for
2146
2147    .. group-tab:: Python
2148
2149       .. automethod:: simgrid.Comm.test
2150       .. automethod:: simgrid.Comm.wait
2151       .. automethod:: simgrid.Comm.wait_all
2152       .. automethod:: simgrid.Comm.wait_any
2153
2154    .. group-tab:: C
2155
2156       .. doxygenfunction:: sg_comm_test
2157       .. doxygenfunction:: sg_comm_wait
2158       .. doxygenfunction:: sg_comm_wait_all
2159       .. doxygenfunction:: sg_comm_wait_any
2160
2161 Signals
2162 -------
2163
2164 .. tabs::
2165
2166    .. group-tab:: C++
2167
2168       .. doxygenvariable:: simgrid::s4u::Comm::on_completion
2169       .. doxygenvariable:: simgrid::s4u::Comm::on_recv
2170       .. doxygenvariable:: simgrid::s4u::Comm::on_send
2171
2172 .. _API_s4u_Exec:
2173
2174 =============
2175 ⁣  class Exec
2176 =============
2177
2178 .. tabs::
2179
2180    .. group-tab:: C++
2181
2182       .. doxygenclass:: simgrid::s4u::Exec
2183
2184    .. group-tab:: Python
2185
2186       .. autoclass:: simgrid.Exec
2187
2188 Basic management
2189 ----------------
2190
2191 .. tabs::
2192
2193    .. group-tab:: C++
2194
2195       .. code-block:: C++
2196
2197          #include <simgrid/s4u/Exec.hpp>
2198
2199       .. doxygentypedef:: ExecPtr
2200
2201    .. group-tab:: Python
2202
2203       .. code:: Python
2204
2205          from simgrid import Exec
2206
2207    .. group-tab:: C
2208
2209       .. code-block:: C
2210
2211          #include <simgrid/exec.h>
2212
2213       .. doxygentypedef:: sg_exec_t
2214       .. doxygentypedef:: const_sg_exec_t
2215
2216 Querying info
2217 -------------
2218
2219 .. tabs::
2220
2221    .. group-tab:: C++
2222
2223       .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
2224       .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
2225       .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
2226       .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
2227       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining
2228       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
2229       .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
2230       .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
2231       .. doxygenfunction:: simgrid::s4u::Exec::set_host
2232       .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
2233
2234    .. group-tab:: Python
2235
2236       .. autoattribute:: simgrid.Exec.host
2237       .. autoattribute:: simgrid.Exec.remaining
2238       .. autoattribute:: simgrid.Exec.remaining_ratio
2239
2240    .. group-tab:: C
2241
2242       .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
2243       .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
2244       .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
2245       .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
2246       .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
2247       .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
2248
2249 Life cycle
2250 ----------
2251
2252 .. tabs::
2253
2254    .. group-tab:: C++
2255
2256       .. doxygenfunction:: simgrid::s4u::Exec::cancel
2257       .. doxygenfunction:: simgrid::s4u::Exec::start
2258       .. doxygenfunction:: simgrid::s4u::Exec::test
2259       .. doxygenfunction:: simgrid::s4u::Exec::wait
2260       .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2261       .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2262       .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2263
2264    .. group-tab:: Python
2265
2266        .. automethod:: simgrid.Exec.cancel
2267        .. automethod:: simgrid.Exec.start
2268        .. automethod:: simgrid.Exec.test
2269        .. automethod:: simgrid.Exec.wait
2270
2271    .. group-tab:: C
2272
2273        .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2274        .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2275        .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2276        .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2277        .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2278        .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2279        .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2280
2281 Signals
2282 -------
2283
2284 .. tabs::
2285
2286    .. group-tab:: C++
2287
2288       .. doxygenvariable:: simgrid::s4u::Exec::on_start
2289       .. doxygenvariable:: simgrid::s4u::Exec::on_completion
2290
2291 .. _API_s4u_Io:
2292
2293 ===========
2294 ⁣  class Io
2295 ===========
2296
2297 .. tabs::
2298
2299    .. group-tab:: C++
2300
2301       .. doxygenclass:: simgrid::s4u::Io
2302
2303    .. group-tab:: Python
2304
2305       .. autoclass:: simgrid.Io
2306
2307 Basic management
2308 ----------------
2309
2310 .. tabs::
2311
2312    .. group-tab:: C++
2313
2314       .. code-block:: C++
2315
2316          #include <simgrid/s4u/Io.hpp>
2317
2318       .. doxygentypedef:: IoPtr
2319
2320 Querying info
2321 -------------
2322
2323 .. tabs::
2324
2325    .. group-tab:: C++
2326
2327       .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2328       .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2329
2330 Life cycle
2331 ----------
2332
2333 .. tabs::
2334
2335    .. group-tab:: C++
2336
2337       .. doxygenfunction:: simgrid::s4u::Io::cancel
2338       .. doxygenfunction:: simgrid::s4u::Io::start
2339       .. doxygenfunction:: simgrid::s4u::Io::test
2340       .. doxygenfunction:: simgrid::s4u::Io::wait
2341       .. doxygenfunction:: simgrid::s4u::Io::wait_for
2342       .. doxygenfunction:: simgrid::s4u::Io::wait_any
2343       .. doxygenfunction:: simgrid::s4u::Io::wait_any_for
2344
2345    .. group-tab:: Python
2346
2347       .. automethod:: simgrid.Io.test
2348       .. automethod:: simgrid.Io.wait
2349       .. automethod:: simgrid.Io.wait_any_for
2350       .. automethod:: simgrid.Io.wait_any
2351
2352 .. _API_s4u_Synchronizations:
2353
2354 =======================
2355 Synchronization Objects
2356 =======================
2357
2358 .. _API_s4u_Mutex:
2359
2360 ==============
2361 ⁣  Mutex
2362 ==============
2363
2364 .. doxygenclass:: simgrid::s4u::Mutex
2365
2366 Basic management
2367 ----------------
2368
2369    .. tabs::
2370
2371       .. group-tab:: C++
2372
2373          .. code-block:: C++
2374
2375             #include <simgrid/s4u/Mutex.hpp>
2376
2377          .. doxygentypedef:: MutexPtr
2378
2379          .. doxygenfunction:: simgrid::s4u::Mutex::create()
2380
2381       .. group-tab:: C
2382
2383          .. code-block:: C
2384
2385             #include <simgrid/mutex.h>
2386
2387          .. doxygentypedef:: sg_mutex_t
2388          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2389
2390             Pointer to a constant mutex object.
2391
2392          .. doxygenfunction:: sg_mutex_init()
2393          .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2394
2395 Locking
2396 -------
2397
2398    .. tabs::
2399
2400       .. group-tab:: C++
2401
2402          .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2403          .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2404          .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2405
2406       .. group-tab:: C
2407
2408          .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2409          .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2410          .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2411
2412 .. _API_s4u_Barrier:
2413
2414 ================
2415 ⁣  Barrier
2416 ================
2417
2418 .. doxygenclass:: simgrid::s4u::Barrier
2419
2420 .. tabs::
2421
2422    .. group-tab:: C++
2423
2424       .. code-block:: C++
2425
2426          #include <simgrid/s4u/Barrier.hpp>
2427
2428       .. doxygentypedef:: BarrierPtr
2429
2430       .. doxygenfunction:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2431       .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2432       .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2433
2434    .. group-tab:: C
2435
2436       .. code-block:: C
2437
2438          #include <simgrid/barrier.hpp>
2439
2440       .. doxygentypedef:: sg_bar_t
2441       .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2442
2443          Pointer to a constant barrier object.
2444
2445       .. doxygenfunction:: sg_barrier_init(unsigned int count)
2446       .. doxygenfunction:: sg_barrier_destroy(const_sg_bar_t bar)
2447       .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2448
2449
2450 .. _API_s4u_ConditionVariable:
2451
2452 ==========================
2453 ⁣  Condition variable
2454 ==========================
2455
2456 .. doxygenclass:: simgrid::s4u::ConditionVariable
2457
2458 Basic management
2459 ----------------
2460
2461    .. tabs::
2462
2463       .. group-tab:: C++
2464
2465          .. code-block:: C++
2466
2467             #include <simgrid/s4u/ConditionVariable.hpp>
2468
2469          .. doxygentypedef:: ConditionVariablePtr
2470
2471          .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2472
2473       .. group-tab:: C
2474
2475          .. code-block:: C
2476
2477             #include <simgrid/cond.h>
2478
2479          .. doxygentypedef:: sg_cond_t
2480          .. doxygentypedef:: const_sg_cond_t
2481          .. doxygenfunction:: sg_cond_init
2482          .. doxygenfunction:: sg_cond_destroy
2483
2484 Waiting and notifying
2485 ---------------------
2486
2487    .. tabs::
2488
2489       .. group-tab:: C++
2490
2491          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2492          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2493          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2494          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2495          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2496          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2497          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2498          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2499          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2500          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2501          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2502          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2503          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2504
2505       .. group-tab:: C
2506
2507          .. doxygenfunction:: sg_cond_notify_all
2508          .. doxygenfunction:: sg_cond_notify_one
2509          .. doxygenfunction:: sg_cond_wait
2510          .. doxygenfunction:: sg_cond_wait_for
2511
2512 .. _API_s4u_Semaphore:
2513
2514 ==================
2515 ⁣  Semaphore
2516 ==================
2517
2518 .. doxygenclass:: simgrid::s4u::Semaphore
2519
2520
2521 Basic management
2522 ----------------
2523
2524    .. tabs::
2525
2526       .. group-tab:: C++
2527
2528          .. code-block:: C++
2529
2530             #include <simgrid/s4u/Semaphore.hpp>
2531
2532          .. doxygentypedef:: SemaphorePtr
2533          .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2534
2535       .. group-tab:: C
2536
2537          .. code-block:: C
2538
2539             #include <simgrid/semaphore.h>
2540
2541          .. doxygentypedef:: sg_sem_t
2542          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2543
2544             Pointer to a constant semaphore object.
2545
2546          .. doxygenfunction:: sg_sem_init(int initial_value)
2547          .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2548
2549 Locking
2550 -------
2551
2552    .. tabs::
2553
2554       .. group-tab:: C++
2555
2556          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2557          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2558          .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2559          .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2560          .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2561
2562       .. group-tab:: C
2563
2564          .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2565          .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2566          .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2567          .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2568          .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)
2569
2570 .. |hr| raw:: html
2571
2572    <hr />