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 Engin 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::get_instance()
 812
 813    .. group-tab:: Python
 814
 815        .. automethod:: simgrid.Engine.instance
 816
 817    .. group-tab:: C
 818
 819       .. doxygenfunction:: simgrid_init
 820
 821 Simulation setup
 822 ----------------
 823
 824 .. tabs::
 825
 826    .. group-tab:: C++
 827
 828       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
 829       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
 830       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
 831       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
 832       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
 833
 834       .. doxygenfunction:: simgrid::s4u::Engine::load_deployment
 835       .. doxygenfunction:: simgrid::s4u::Engine::load_platform
 836       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name)
 837       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 838       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
 839       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
 840
 841       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
 842       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
 843       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
 844
 845    .. group-tab:: Python
 846
 847        .. automethod:: simgrid.Engine.load_deployment
 848        .. automethod:: simgrid.Engine.load_platform
 849        .. automethod:: simgrid.Engine.register_actor
 850
 851    .. group-tab:: C
 852
 853       .. doxygenfunction:: simgrid_load_deployment
 854       .. doxygenfunction:: simgrid_load_platform
 855       .. doxygenfunction:: simgrid_register_default
 856       .. doxygenfunction:: simgrid_register_function
 857
 858
 859 Run the simulation
 860 ------------------
 861
 862 .. tabs::
 863
 864    .. group-tab:: C++
 865
 866       .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
 867       .. doxygenfunction:: simgrid::s4u::Engine::run
 868       .. doxygenfunction:: simgrid::s4u::Engine::run_until
 869
 870    .. group-tab:: Python
 871
 872       .. automethod:: simgrid.Engine.get_clock
 873       .. automethod:: simgrid.Engine.run
 874       .. automethod:: simgrid.Engine.run_until
 875
 876    .. group-tab:: C
 877
 878       .. doxygenfunction:: simgrid_get_clock
 879       .. doxygenfunction:: simgrid_run
 880       .. doxygenfunction:: simgrid_run_until
 881
 882 Retrieving actors
 883 -----------------
 884
 885 .. tabs::
 886
 887    .. group-tab:: C++
 888
 889       .. doxygenfunction:: simgrid::s4u::Engine::get_actor_count
 890       .. doxygenfunction:: simgrid::s4u::Engine::get_all_actors
 891       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_actors
 892
 893    .. group-tab:: C
 894
 895       .. doxygenfunction:: sg_actor_count()
 896
 897 Retrieving hosts
 898 ----------------
 899
 900 .. tabs::
 901
 902    .. group-tab:: C++
 903
 904       .. doxygenfunction:: simgrid::s4u::Engine::get_all_hosts
 905       .. doxygenfunction:: simgrid::s4u::Engine::get_host_count
 906       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_hosts
 907       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name
 908       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name_or_null
 909
 910    .. group-tab:: Python
 911
 912       .. automethod:: simgrid.Engine.get_all_hosts
 913
 914    .. group-tab:: C
 915
 916       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 917
 918 Retrieving links
 919 ----------------
 920
 921 .. tabs::
 922
 923    .. group-tab:: C++
 924
 925       .. doxygenfunction:: simgrid::s4u::Engine::get_all_links
 926       .. doxygenfunction:: simgrid::s4u::Engine::get_link_count
 927       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_links
 928       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name
 929       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name_or_null
 930
 931 Interacting with the routing
 932 ----------------------------
 933
 934 .. tabs::
 935
 936    .. group-tab:: C++
 937
 938       .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
 939       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
 940       .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
 941       .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
 942       .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
 943       .. doxygenfunction:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 944
 945 Signals
 946 -------
 947
 948 .. tabs::
 949
 950    .. group-tab:: C++
 951
 952       .. doxygenvariable:: simgrid::s4u::Engine::on_deadlock
 953       .. doxygenvariable:: simgrid::s4u::Engine::on_platform_created
 954       .. doxygenvariable:: simgrid::s4u::Engine::on_platform_creation
 955       .. doxygenvariable:: simgrid::s4u::Engine::on_simulation_end
 956       .. doxygenvariable:: simgrid::s4u::Engine::on_time_advance
 957
 958 .. _API_s4u_Mailbox:
 959
 960 ================
 961 ⁣  class Mailbox
 962 ================
 963
 964 .. tabs::
 965
 966    .. group-tab:: C++
 967
 968       .. doxygenclass:: simgrid::s4u::Mailbox
 969
 970    .. group-tab:: Python
 971
 972       .. autoclass:: simgrid.Mailbox
 973
 974 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 975
 976 Basic management
 977 ----------------
 978
 979 .. tabs::
 980
 981    .. group-tab:: C++
 982
 983       .. code-block:: C++
 984
 985          #include <simgrid/s4u/Mailbox.hpp>
 986
 987       Note that there is no MailboxPtr type and that you cannot use the RAII
 988       idiom on mailboxes because they are internal objects to the simulation
 989       engine. Once created, there is no way to destroy a mailbox before the end
 990       of the simulation.
 991
 992       .. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
 993
 994    .. group-tab:: Python
 995
 996       .. code-block:: C++
 997
 998          #include <simgrid/mailbox.h>
 999
1000       .. automethod:: simgrid.Mailbox.by_name
1001
1002    .. group-tab:: C
1003
1004       .. code-block:: C
1005
1006          #include <simgrid/s4u/mailbox.h>
1007
1008       .. doxygentypedef:: sg_mailbox_t
1009       .. doxygentypedef:: const_sg_mailbox_t
1010
1011       .. doxygenfunction:: sg_mailbox_by_name(const char *alias)
1012
1013 Querying info
1014 -------------
1015
1016 .. tabs::
1017
1018    .. group-tab:: C++
1019
1020       .. doxygenfunction:: simgrid::s4u::Mailbox::get_cname
1021       .. doxygenfunction:: simgrid::s4u::Mailbox::get_name
1022
1023    .. group-tab:: Python
1024
1025       .. autoattribute:: simgrid.Mailbox.name
1026
1027 Sending data
1028 ------------
1029
1030 .. tabs::
1031
1032    .. group-tab:: C++
1033
1034       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
1035       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
1036       .. doxygenfunction:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
1037       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init()
1038       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
1039
1040    .. group-tab:: Python
1041
1042       .. automethod:: simgrid.Mailbox.put
1043       .. automethod:: simgrid.Mailbox.put_async
1044
1045    .. group-tab:: C
1046
1047       .. doxygenfunction:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1048       .. doxygenfunction:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1049       .. doxygenfunction:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1050
1051
1052 Receiving data
1053 --------------
1054
1055 .. tabs::
1056
1057    .. group-tab:: C++
1058
1059       .. doxygenfunction:: simgrid::s4u::Mailbox::empty
1060       .. doxygenfunction:: simgrid::s4u::Mailbox::front
1061       .. doxygenfunction:: simgrid::s4u::Mailbox::get()
1062       .. doxygenfunction:: simgrid::s4u::Mailbox::get(double timeout)
1063       .. doxygenfunction:: simgrid::s4u::Mailbox::get_async(T **data)
1064       .. doxygenfunction:: simgrid::s4u::Mailbox::get_init()
1065       .. doxygenfunction:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
1066       .. doxygenfunction:: simgrid::s4u::Mailbox::listen
1067       .. doxygenfunction:: simgrid::s4u::Mailbox::ready
1068
1069    .. group-tab:: Python
1070
1071        .. automethod:: simgrid.Mailbox.get
1072        .. automethod:: simgrid.Mailbox.get_async
1073
1074    .. group-tab:: C
1075
1076       .. doxygenfunction:: sg_mailbox_get(sg_mailbox_t mailbox)
1077       .. doxygenfunction:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1078       .. doxygenfunction:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1079       .. doxygenfunction:: sg_mailbox_listen(const char *alias)
1080
1081 Receiving actor
1082 ---------------
1083
1084 See :ref:`s4u_receiving_actor`.
1085
1086 .. tabs::
1087
1088    .. group-tab:: C++
1089
1090       .. doxygenfunction:: simgrid::s4u::Mailbox::get_receiver
1091       .. doxygenfunction:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1092
1093    .. group-tab:: C
1094
1095       .. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
1096
1097 .. _API_s4u_Resource:
1098
1099 =========
1100 Resources
1101 =========
1102
1103 .. _API_s4u_Disk:
1104
1105 =============
1106 ⁣  class Disk
1107 =============
1108
1109 .. tabs::
1110
1111    .. group-tab:: C++
1112
1113       .. doxygenclass:: simgrid::s4u::Disk
1114
1115    .. group-tab:: Python
1116
1117       .. autoclass:: simgrid.Disk
1118
1119 Basic management
1120 ----------------
1121
1122 .. tabs::
1123
1124    .. group-tab:: C++
1125
1126       .. code-block:: C++
1127
1128          #include <simgrid/s4u/Disk.hpp>
1129
1130       Note that there is no DiskPtr type and that you cannot use the RAII
1131       idiom on disks because SimGrid does not allow (yet) to create nor
1132       destroy resources once the simulation is started.
1133
1134       .. doxygenfunction:: simgrid::s4u::Disk::seal()
1135
1136    .. group-tab:: Python
1137
1138       .. code:: Python
1139
1140          from simgrid import Disk
1141
1142       .. automethod:: simgrid.Disk.seal
1143
1144
1145 Querying info
1146 -------------
1147
1148 .. tabs::
1149
1150    .. group-tab:: C++
1151
1152       .. doxygenfunction:: simgrid::s4u::Disk::get_cname() const
1153       .. doxygenfunction:: simgrid::s4u::Disk::get_host() const
1154       .. doxygenfunction:: simgrid::s4u::Disk::get_name() const
1155       .. doxygenfunction:: simgrid::s4u::Disk::get_properties() const
1156       .. doxygenfunction:: simgrid::s4u::Disk::get_property(const std::string &key) const
1157       .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
1158       .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
1159       .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1160       .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1161
1162    .. group-tab:: Python
1163
1164       .. autoattribute:: simgrid.Disk.name
1165       .. automethod:: simgrid.Disk.set_sharing_policy
1166
1167 I/O operations
1168 --------------
1169
1170 .. tabs::
1171
1172    .. group-tab:: C++
1173
1174       .. doxygenfunction:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type) const
1175       .. doxygenfunction:: simgrid::s4u::Disk::read(sg_size_t size) const
1176       .. doxygenfunction:: simgrid::s4u::Disk::read_async(sg_size_t size) const
1177       .. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
1178       .. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
1179
1180    .. group-tab:: Python
1181
1182       .. automethod:: simgrid.Disk.read
1183       .. automethod:: simgrid.Disk.read_async
1184       .. automethod:: simgrid.Disk.write
1185       .. automethod:: simgrid.Disk.write_async
1186
1187 Signals
1188 -------
1189
1190 .. tabs::
1191
1192    .. group-tab:: C++
1193
1194       .. doxygenvariable:: simgrid::s4u::Disk::on_creation
1195       .. doxygenvariable:: simgrid::s4u::Disk::on_destruction
1196       .. doxygenvariable:: simgrid::s4u::Disk::on_state_change
1197
1198
1199 .. _API_s4u_Host:
1200
1201 =============
1202 ⁣  class Host
1203 =============
1204
1205 .. tabs::
1206
1207    .. group-tab:: C++
1208
1209       .. doxygenclass:: simgrid::s4u::Host
1210
1211    .. group-tab:: Python
1212
1213       .. autoclass:: simgrid.Host
1214
1215 Basic management
1216 ----------------
1217
1218 .. tabs::
1219
1220    .. group-tab:: C++
1221
1222       .. code-block:: C++
1223
1224          #include <simgrid/s4u/Host.hpp>
1225
1226       Note that there is no HostPtr type, and that you cannot use the RAII
1227       idiom on hosts because SimGrid does not allow (yet) to create nor
1228       destroy resources once the simulation is started.
1229
1230       .. doxygenfunction:: simgrid::s4u::Host::destroy()
1231       .. doxygenfunction:: simgrid::s4u::Host::seal()
1232
1233    .. group-tab:: Python
1234
1235       .. code:: Python
1236
1237          from simgrid import Host
1238
1239       .. automethod:: simgrid.Host.seal
1240
1241    .. group-tab:: C
1242
1243       .. code:: C
1244
1245          #include <simgrid/host.h>
1246
1247       .. doxygentypedef:: sg_host_t
1248       .. cpp:type:: const s4u_Host* const_sg_host_t
1249
1250          Pointer to a constant host object.
1251
1252 Retrieving hosts
1253 ----------------
1254
1255 .. tabs::
1256
1257    .. group-tab:: C++
1258
1259       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1260
1261       .. doxygenfunction:: simgrid::s4u::Host::by_name(const std::string &name)
1262       .. doxygenfunction:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1263       .. doxygenfunction:: simgrid::s4u::Host::current()
1264
1265    .. group-tab:: Python
1266
1267       See also :py:func:`simgrid.Engine.get_all_hosts`.
1268
1269       .. automethod:: simgrid.Host.by_name
1270       .. automethod:: simgrid.Host.current
1271
1272    .. group-tab:: C
1273
1274       .. doxygenfunction:: sg_host_by_name(const char *name)
1275       .. doxygenfunction:: sg_host_count()
1276       .. doxygenfunction:: sg_host_list()
1277
1278 Modifying characteristics
1279 -------------------------
1280
1281 .. tabs::
1282
1283    .. group-tab:: C++
1284
1285       .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count)
1286       .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords)
1287       .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1288
1289    .. group-tab:: Python
1290
1291       .. automethod:: simgrid.Host.set_core_count
1292       .. automethod:: simgrid.Host.set_coordinates
1293       .. automethod:: simgrid.Host.set_sharing_policy
1294
1295 Querying info
1296 -------------
1297
1298 .. tabs::
1299
1300    .. group-tab:: C++
1301
1302       .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1303       .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1304       .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1305       .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1306       .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1307       .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1308
1309    .. group-tab:: Python
1310
1311       .. autoattribute:: simgrid.Host.name
1312       .. autoattribute:: simgrid.Host.load
1313       .. autoattribute:: simgrid.Host.pstate
1314       .. autoattribute:: simgrid.Host.speed
1315
1316    .. group-tab:: C
1317
1318       .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1319       .. doxygenfunction:: sg_host_dump(const_sg_host_t ws)
1320       .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1321       .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1322       .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1323
1324 User data and properties
1325 ------------------------
1326
1327 .. tabs::
1328
1329    .. group-tab:: C++
1330
1331       .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1332       .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1333       .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1334       .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1335
1336    .. group-tab:: C
1337
1338       .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1339       .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1340       .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1341       .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1342       .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1343
1344 Retrieving components
1345 ---------------------
1346
1347 .. tabs::
1348
1349    .. group-tab:: C++
1350
1351       .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1352       .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1353       .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1354       .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1355       .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1356
1357    .. group-tab:: Python
1358
1359       .. automethod:: simgrid.Host.get_disks
1360
1361    .. group-tab:: C
1362
1363       .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1364
1365 On/Off
1366 ------
1367
1368 .. tabs::
1369
1370    .. group-tab:: C++
1371
1372       .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1373       .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1374       .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1375
1376    .. group-tab:: C
1377
1378       .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1379       .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1380       .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1381
1382 DVFS
1383 ----
1384
1385 .. tabs::
1386
1387    .. group-tab:: C++
1388
1389       .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1390       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1391       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(unsigned long pstate_index) const
1392       .. doxygenfunction:: simgrid::s4u::Host::set_pstate(unsigned long pstate_index)
1393       .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1394       .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1395
1396    .. group-tab:: Python
1397
1398       .. automethod:: simgrid.Host.get_pstate_count
1399       .. automethod:: simgrid.Host.get_pstate_speed
1400
1401    .. group-tab:: C
1402
1403       .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1404       .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1405       .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1406       .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
1407       .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, unsigned long pstate)
1408
1409 Execution
1410 ---------
1411
1412 .. tabs::
1413
1414    .. group-tab:: C++
1415
1416       .. doxygenfunction:: simgrid::s4u::Host::exec_async
1417       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1418       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1419
1420 Platform and routing
1421 --------------------
1422
1423 You can also start direct communications between two arbitrary hosts
1424 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1425
1426 .. tabs::
1427
1428    .. group-tab:: C++
1429
1430       .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1431       .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1432       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1433       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
1434       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
1435       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
1436
1437    .. group-tab:: Python
1438
1439       .. automethod:: simgrid.Host.get_netpoint
1440       .. automethod:: simgrid.Host.create_disk
1441
1442    .. group-tab:: C
1443
1444       .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1445       .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1446       .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1447       .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1448
1449 Signals
1450 -------
1451
1452 .. tabs::
1453
1454    .. group-tab:: C++
1455
1456       .. doxygenvariable:: simgrid::s4u::Host::on_creation
1457       .. doxygenvariable:: simgrid::s4u::Host::on_destruction
1458       .. doxygenvariable:: simgrid::s4u::Host::on_speed_change
1459       .. doxygenvariable:: simgrid::s4u::Host::on_state_change
1460
1461 .. _API_s4u_Link:
1462
1463 =============
1464 ⁣  class Link
1465 =============
1466
1467 .. tabs::
1468
1469    .. group-tab:: C++
1470
1471       .. doxygenclass:: simgrid::s4u::Link
1472       .. doxygenclass:: simgrid::s4u::SplitDuplexLink
1473       .. doxygenclass:: simgrid::s4u::LinkInRoute
1474
1475
1476    .. group-tab:: Python
1477
1478       .. autoclass:: simgrid.Link
1479
1480 Basic management
1481 ----------------
1482
1483 .. tabs::
1484
1485    .. group-tab:: C++
1486
1487       .. code-block:: C++
1488
1489          #include <simgrid/s4u/Link.hpp>
1490
1491       Note that there is no LinkPtr type and that you cannot use the RAII
1492       idiom on hosts because SimGrid does not allow (yet) to create nor
1493       destroy resources once the simulation is started.
1494
1495       .. doxygenfunction:: simgrid::s4u::Link::seal()
1496
1497    .. group-tab:: Python
1498
1499       .. code:: Python
1500
1501          from simgrid import Link
1502
1503       .. automethod:: simgrid.Link.seal
1504
1505    .. group-tab:: C
1506
1507       .. code:: C
1508
1509          #include <simgrid/link.h>
1510
1511       .. doxygentypedef:: sg_link_t
1512       .. cpp:type:: const s4u_Link* const_sg_link_t
1513
1514          Pointer to a constant link object.
1515
1516 Retrieving links
1517 ----------------
1518
1519 .. tabs::
1520
1521    .. group-tab:: C++
1522
1523       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1524
1525       .. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
1526       .. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1527
1528    .. group-tab:: Python
1529
1530       .. automethod:: simgrid.Link.by_name
1531       .. autoattribute:: simgrid.Link.name
1532
1533    .. group-tab:: C
1534
1535       .. doxygenfunction:: sg_link_by_name(const char *name)
1536       .. doxygenfunction:: sg_link_count()
1537       .. doxygenfunction:: sg_link_list()
1538
1539 Querying info
1540 --------------
1541
1542 .. tabs::
1543
1544    .. group-tab:: C++
1545
1546       .. doxygenfunction:: simgrid::s4u::Link::get_bandwidth() const
1547       .. doxygenfunction:: simgrid::s4u::Link::get_cname() const
1548       .. doxygenfunction:: simgrid::s4u::Link::get_latency() const
1549       .. doxygenfunction:: simgrid::s4u::Link::get_name() const
1550       .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const
1551       .. doxygenfunction:: simgrid::s4u::Link::get_usage() const
1552       .. doxygenfunction:: simgrid::s4u::Link::is_used() const
1553
1554    .. group-tab:: C
1555
1556       .. doxygenfunction:: sg_link_get_bandwidth(const_sg_link_t link)
1557       .. doxygenfunction:: sg_link_get_latency(const_sg_link_t link)
1558       .. doxygenfunction:: sg_link_get_name(const_sg_link_t link)
1559       .. doxygenfunction:: sg_link_is_shared(const_sg_link_t link)
1560
1561 Modifying characteristics
1562 -------------------------
1563
1564 .. tabs::
1565
1566    .. group-tab:: C++
1567
1568       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
1569       .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
1570       .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value)
1571       .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit)
1572       .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {})
1573
1574    .. group-tab:: Python
1575
1576       .. automethod:: simgrid.Link.set_latency
1577       .. automethod:: simgrid.Link.set_concurrency_limit
1578       .. automethod:: simgrid.Link.set_sharing_policy
1579
1580    .. group-tab:: C
1581
1582       .. doxygenfunction:: sg_link_set_bandwidth(sg_link_t link, double value)
1583       .. doxygenfunction:: sg_link_set_latency(sg_link_t link, double value)
1584
1585 User data and properties
1586 ------------------------
1587
1588 .. tabs::
1589
1590    .. group-tab:: C++
1591
1592       .. doxygenfunction:: simgrid::s4u::Link::get_property(const std::string &key) const
1593       .. doxygenfunction:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1594
1595    .. group-tab:: C
1596
1597       .. doxygenfunction:: sg_link_get_data(const_sg_link_t link)
1598       .. doxygenfunction:: sg_link_set_data(sg_link_t link, void *data)
1599
1600 On/Off
1601 ------
1602
1603 .. tabs::
1604
1605    .. group-tab:: C++
1606
1607       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1608
1609       .. doxygenfunction:: simgrid::s4u::Link::is_on() const
1610       .. doxygenfunction:: simgrid::s4u::Link::turn_off()
1611       .. doxygenfunction:: simgrid::s4u::Link::turn_on()
1612
1613 Dynamic profiles
1614 ----------------
1615
1616 See :ref:`howto_churn` for more details.
1617
1618 .. tabs::
1619
1620    .. group-tab:: C++
1621
1622       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1623       .. doxygenfunction:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1624       .. doxygenfunction:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1625
1626 WIFI links
1627 ----------
1628
1629 .. tabs::
1630
1631    .. group-tab:: C++
1632
1633       .. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
1634
1635    .. group-tab:: Python
1636
1637       .. automethod:: simgrid.Link.set_host_wifi_rate
1638
1639 Signals
1640 -------
1641
1642 .. tabs::
1643
1644    .. group-tab:: C++
1645
1646       .. doxygenvariable:: simgrid::s4u::Link::on_bandwidth_change
1647       .. doxygenvariable:: simgrid::s4u::Link::on_communication_state_change
1648       .. doxygenvariable:: simgrid::s4u::Link::on_creation
1649       .. doxygenvariable:: simgrid::s4u::Link::on_destruction
1650       .. doxygenvariable:: simgrid::s4u::Link::on_state_change
1651
1652 .. _API_s4u_NetZone:
1653
1654 ================
1655 ⁣  class NetZone
1656 ================
1657
1658 .. tabs::
1659
1660    .. group-tab:: C++
1661
1662       .. doxygenclass:: simgrid::s4u::NetZone
1663
1664    .. group-tab:: Python
1665
1666       .. autoclass:: simgrid.NetZone
1667
1668 Basic management
1669 ----------------
1670
1671 .. tabs::
1672
1673    .. group-tab:: C++
1674
1675       .. code-block:: C++
1676
1677          #include <simgrid/s4u/NetZone.hpp>
1678
1679       Note that there is no NetZonePtr type and that you cannot use the RAII
1680       idiom on network zones because SimGrid does not allow (yet) to create nor
1681       destroy resources once the simulation is started.
1682
1683       .. doxygenfunction:: simgrid::s4u::NetZone::seal
1684
1685    .. group-tab:: Python
1686
1687       .. code:: Python
1688
1689          from simgrid import NetZone
1690
1691       .. automethod:: simgrid.NetZone.seal
1692
1693    .. group-tab:: C
1694
1695       .. code:: C
1696
1697          #include <simgrid/zone.h>
1698
1699       .. doxygentypedef:: sg_netzone_t
1700       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1701
1702          Pointer to a constant network zone object.
1703
1704 Retrieving zones
1705 ----------------
1706
1707 .. tabs::
1708
1709    .. group-tab:: C++
1710
1711       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1712       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1713       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1714
1715    .. group-tab:: C
1716
1717       .. doxygenfunction:: sg_zone_get_by_name(const char *name)
1718       .. doxygenfunction:: sg_zone_get_root()
1719
1720 Querying info
1721 --------------
1722
1723 .. tabs::
1724
1725    .. group-tab:: C++
1726
1727       .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
1728       .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
1729       .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint()
1730
1731    .. group-tab:: Python
1732
1733       .. autoattribute:: simgrid.NetZone.name
1734       .. automethod:: simgrid.NetZone.get_netpoint
1735
1736    .. group-tab:: C
1737
1738       .. doxygenfunction:: sg_zone_get_name(const_sg_netzone_t zone)
1739
1740 User data and properties
1741 ------------------------
1742
1743 .. tabs::
1744
1745    .. group-tab:: C++
1746
1747       .. doxygenfunction:: simgrid::s4u::NetZone::get_properties() const
1748       .. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1749       .. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1750
1751    .. group-tab:: Python
1752
1753       .. automethod:: simgrid.NetZone.set_property
1754
1755    .. group-tab:: C
1756
1757       .. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1758       .. doxygenfunction:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1759
1760 Retrieving components
1761 ---------------------
1762
1763 .. tabs::
1764
1765    .. group-tab:: C++
1766
1767       .. doxygenfunction:: simgrid::s4u::NetZone::get_all_hosts() const
1768       .. doxygenfunction:: simgrid::s4u::NetZone::get_host_count() const
1769
1770    .. group-tab:: C
1771
1772       .. doxygenfunction:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1773
1774 Routing data
1775 ------------
1776
1777 .. tabs::
1778
1779    .. group-tab:: C++
1780
1781       .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1782       .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1783       .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
1784       .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1785       .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
1786       .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent)
1787
1788    .. group-tab:: Python
1789
1790       .. automethod:: simgrid.NetZone.add_route
1791       .. automethod:: simgrid.NetZone.set_parent
1792
1793    .. group-tab:: C
1794
1795       .. doxygenfunction:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1796
1797 Signals
1798 -------
1799
1800 .. tabs::
1801
1802   .. group-tab:: C++
1803
1804      .. doxygenvariable:: simgrid::s4u::NetZone::on_creation
1805      .. doxygenvariable:: simgrid::s4u::NetZone::on_seal
1806
1807 Creating resources
1808 ------------------
1809
1810 Zones
1811 ^^^^^
1812 .. tabs::
1813
1814   .. group-tab:: C++
1815
1816      .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name)
1817      .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name)
1818      .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name)
1819      .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache)
1820      .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name)
1821      .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name)
1822      .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name)
1823      .. doxygenfunction:: simgrid::s4u::create_torus_zone
1824      .. 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)
1825      .. 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)
1826
1827   .. group-tab:: Python
1828
1829      .. automethod:: simgrid.NetZone.create_full_zone
1830      .. automethod:: simgrid.NetZone.create_empty_zone
1831      .. automethod:: simgrid.NetZone.create_star_zone
1832      .. automethod:: simgrid.NetZone.create_dijkstra_zone
1833      .. automethod:: simgrid.NetZone.create_floyd_zone
1834      .. automethod:: simgrid.NetZone.create_vivaldi_zone
1835      .. automethod:: simgrid.NetZone.create_wifi_zone
1836      .. automethod:: simgrid.NetZone.create_torus_zone
1837      .. automethod:: simgrid.NetZone.create_fatTree_zone
1838      .. automethod:: simgrid.NetZone.create_dragonfly_zone
1839
1840 Hosts
1841 ^^^^^
1842
1843 .. tabs::
1844
1845   .. group-tab:: C++
1846
1847      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
1848      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed)
1849      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
1850      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed)
1851
1852   .. group-tab:: Python
1853
1854      .. automethod:: simgrid.NetZone.create_host
1855
1856 Links
1857 ^^^^^
1858
1859 .. tabs::
1860
1861   .. group-tab:: C++
1862
1863      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
1864      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth)
1865      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidthds)
1866      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth)
1867      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
1868      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
1869
1870   .. group-tab:: Python
1871
1872      .. automethod:: simgrid.NetZone.create_link
1873      .. automethod:: simgrid.NetZone.create_split_duplex_link
1874
1875 Router
1876 ^^^^^^
1877
1878 .. tabs::
1879
1880   .. group-tab:: C++
1881
1882      .. doxygenfunction:: simgrid::s4u::NetZone::create_router(const std::string& name)
1883
1884   .. group-tab:: Python
1885
1886      .. automethod:: simgrid.NetZone.create_router
1887
1888 .. _API_s4u_VirtualMachine:
1889
1890 =======================
1891 ⁣  class VirtualMachine
1892 =======================
1893
1894
1895 .. doxygenclass:: simgrid::s4u::VirtualMachine
1896
1897 Basic management
1898 ----------------
1899 .. tabs::
1900
1901    .. group-tab:: C++
1902
1903       .. code-block:: C++
1904
1905          #include <simgrid/s4u/VirtualMachine.hpp>
1906
1907       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1908       idiom on virtual machines. There is no good reason for that and should change in the future.
1909
1910    .. group-tab:: C
1911
1912       .. code:: C
1913
1914          #include <simgrid/vm.h>
1915
1916       .. doxygentypedef:: sg_vm_t
1917       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1918
1919          Pointer to a constant virtual machine object.
1920
1921 Creating VMs
1922 ------------
1923
1924 .. tabs::
1925
1926    .. group-tab:: C++
1927
1928       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount)
1929       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount, size_t ramsize)
1930       .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1931
1932    .. group-tab:: C
1933
1934       .. doxygenfunction:: sg_vm_create_core
1935       .. doxygenfunction:: sg_vm_create_multicore
1936       .. doxygenfunction:: sg_vm_destroy
1937
1938 Querying info
1939 --------------
1940
1941 .. tabs::
1942
1943    .. group-tab:: C++
1944
1945       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1946       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
1947       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
1948
1949       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1950       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1951       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1952
1953    .. group-tab:: C
1954
1955       .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
1956       .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
1957       .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1958
1959       .. doxygenfunction:: sg_vm_get_name
1960       .. doxygenfunction:: sg_vm_get_pm
1961       .. doxygenfunction:: sg_vm_is_created
1962       .. doxygenfunction:: sg_vm_is_running
1963       .. doxygenfunction:: sg_vm_is_suspended
1964
1965 Life cycle
1966 ----------
1967
1968 .. tabs::
1969
1970    .. group-tab:: C++
1971
1972       .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
1973       .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
1974       .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
1975       .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
1976
1977    .. group-tab:: C
1978
1979       .. doxygenfunction:: sg_vm_start
1980       .. doxygenfunction:: sg_vm_suspend
1981       .. doxygenfunction:: sg_vm_resume
1982       .. doxygenfunction:: sg_vm_shutdown
1983
1984 Signals
1985 -------
1986
1987 .. tabs::
1988
1989    .. group-tab:: C++
1990
1991       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_creation
1992       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_destruction
1993       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_end
1994       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_start
1995       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_resume
1996       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_shutdown
1997       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_start
1998       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_started
1999       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_suspend
2000
2001 .. _API_s4u_Activity:
2002
2003 ==========
2004 Activities
2005 ==========
2006
2007 ==============
2008 class Activity
2009 ==============
2010
2011 .. doxygenclass:: simgrid::s4u::Activity
2012
2013 **Known subclasses:**
2014 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
2015 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
2016 :ref:`I/O <API_s4u_Io>` (started on and consuming disks).
2017 See also the :ref:`section on activities <s4u_Activities>` above.
2018
2019 Basic management
2020 ----------------
2021
2022 .. tabs::
2023
2024    .. group-tab:: C++
2025
2026       .. code-block:: C++
2027
2028          #include <simgrid/s4u/Activity.hpp>
2029
2030       .. doxygentypedef:: ActivityPtr
2031
2032 Querying info
2033 -------------
2034
2035 .. tabs::
2036
2037    .. group-tab:: C++
2038
2039       .. doxygenfunction:: simgrid::s4u::Activity::get_cname
2040       .. doxygenfunction:: simgrid::s4u::Activity::get_name
2041       .. doxygenfunction:: simgrid::s4u::Activity::get_remaining() const
2042       .. doxygenfunction:: simgrid::s4u::Activity::get_state() const
2043       .. doxygenfunction:: simgrid::s4u::Activity::set_remaining(double remains)
2044       .. doxygenfunction:: simgrid::s4u::Activity::set_state(Activity::State state)
2045
2046
2047 Activities life cycle
2048 ---------------------
2049
2050 .. tabs::
2051
2052    .. group-tab:: C++
2053
2054       .. doxygenfunction:: simgrid::s4u::Activity::start
2055       .. doxygenfunction:: simgrid::s4u::Activity::cancel
2056       .. doxygenfunction:: simgrid::s4u::Activity::test
2057       .. doxygenfunction:: simgrid::s4u::Activity::wait
2058       .. doxygenfunction:: simgrid::s4u::Activity::wait_for
2059       .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit)
2060       .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start()
2061
2062 Suspending and resuming an activity
2063 -----------------------------------
2064
2065 .. tabs::
2066
2067    .. group-tab:: C++
2068
2069       .. doxygenfunction:: simgrid::s4u::Activity::suspend
2070       .. doxygenfunction:: simgrid::s4u::Activity::resume
2071       .. doxygenfunction:: simgrid::s4u::Activity::is_suspended
2072
2073 .. _API_s4u_Comm:
2074
2075 =============
2076 ⁣  class Comm
2077 =============
2078
2079 .. tabs::
2080
2081    .. group-tab:: C++
2082
2083       .. doxygenclass:: simgrid::s4u::Comm
2084
2085    .. group-tab:: Python
2086
2087       .. autoclass:: simgrid.Comm
2088
2089 Basic management
2090 ----------------
2091
2092 .. tabs::
2093
2094    .. group-tab:: C++
2095
2096       .. code-block:: C++
2097
2098          #include <simgrid/s4u/Comm.hpp>
2099
2100       .. doxygentypedef:: CommPtr
2101
2102    .. group-tab:: Python
2103
2104       .. code:: Python
2105
2106          from simgrid import Comm
2107
2108    .. group-tab:: c
2109
2110       .. code:: c
2111
2112          #include <simgrid/comm.h>
2113
2114       .. doxygentypedef:: sg_comm_t
2115       .. doxygentypedef:: const_sg_comm_t
2116
2117 Querying info
2118 -------------
2119
2120 .. tabs::
2121
2122    .. group-tab:: C++
2123
2124       .. doxygenfunction:: simgrid::s4u::Comm::get_dst_data_size() const
2125       .. doxygenfunction:: simgrid::s4u::Comm::get_mailbox() const
2126       .. doxygenfunction:: simgrid::s4u::Comm::get_sender() const
2127       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff)
2128       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
2129       .. doxygenfunction:: simgrid::s4u::Comm::detach()
2130       .. doxygenfunction:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
2131       .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(uint64_t bytes)
2132       .. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
2133       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
2134       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
2135       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data_size(size_t size)
2136
2137 Life cycle
2138 ----------
2139
2140 Most communications are created using :ref:`s4u_mailbox`, but you can
2141 also start direct communications as shown below.
2142
2143 .. tabs::
2144
2145    .. group-tab:: C++
2146
2147       .. doxygenfunction:: simgrid::s4u::Comm::sendto
2148       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init()
2149       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init(Host *from, Host *to)
2150       .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
2151
2152       .. doxygenfunction:: simgrid::s4u::Comm::cancel
2153       .. doxygenfunction:: simgrid::s4u::Comm::start
2154       .. doxygenfunction:: simgrid::s4u::Comm::test
2155       .. doxygenfunction:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr >& comms)
2156       .. doxygenfunction:: simgrid::s4u::Comm::wait
2157       .. doxygenfunction:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr >& comms)
2158       .. doxygenfunction:: simgrid::s4u::Comm::wait_all_for(const std::vector< CommPtr >& comms, double timeout)
2159       .. doxygenfunction:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr >& comms)
2160       .. doxygenfunction:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr >& comms, double timeout)
2161       .. doxygenfunction:: simgrid::s4u::Comm::wait_for
2162
2163    .. group-tab:: Python
2164
2165       .. automethod:: simgrid.Comm.test
2166       .. automethod:: simgrid.Comm.wait
2167       .. automethod:: simgrid.Comm.wait_all
2168       .. automethod:: simgrid.Comm.wait_any
2169
2170    .. group-tab:: C
2171
2172       .. doxygenfunction:: sg_comm_test
2173       .. doxygenfunction:: sg_comm_wait
2174       .. doxygenfunction:: sg_comm_wait_all
2175       .. doxygenfunction:: sg_comm_wait_any
2176
2177 Signals
2178 -------
2179
2180 .. tabs::
2181
2182    .. group-tab:: C++
2183
2184       .. doxygenvariable:: simgrid::s4u::Comm::on_completion
2185       .. doxygenvariable:: simgrid::s4u::Comm::on_recv
2186       .. doxygenvariable:: simgrid::s4u::Comm::on_send
2187
2188 .. _API_s4u_Exec:
2189
2190 =============
2191 ⁣  class Exec
2192 =============
2193
2194 .. tabs::
2195
2196    .. group-tab:: C++
2197
2198       .. doxygenclass:: simgrid::s4u::Exec
2199
2200    .. group-tab:: Python
2201
2202       .. autoclass:: simgrid.Exec
2203
2204 Basic management
2205 ----------------
2206
2207 .. tabs::
2208
2209    .. group-tab:: C++
2210
2211       .. code-block:: C++
2212
2213          #include <simgrid/s4u/Exec.hpp>
2214
2215       .. doxygentypedef:: ExecPtr
2216
2217    .. group-tab:: Python
2218
2219       .. code:: Python
2220
2221          from simgrid import Exec
2222
2223    .. group-tab:: C
2224
2225       .. code-block:: C
2226
2227          #include <simgrid/exec.h>
2228
2229       .. doxygentypedef:: sg_exec_t
2230       .. doxygentypedef:: const_sg_exec_t
2231
2232 Querying info
2233 -------------
2234
2235 .. tabs::
2236
2237    .. group-tab:: C++
2238
2239       .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
2240       .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
2241       .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
2242       .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
2243       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining
2244       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
2245       .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
2246       .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
2247       .. doxygenfunction:: simgrid::s4u::Exec::set_host
2248       .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
2249
2250    .. group-tab:: Python
2251
2252       .. autoattribute:: simgrid.Exec.host
2253       .. autoattribute:: simgrid.Exec.remaining
2254       .. autoattribute:: simgrid.Exec.remaining_ratio
2255
2256    .. group-tab:: C
2257
2258       .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
2259       .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
2260       .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
2261       .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
2262       .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
2263       .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
2264
2265 Life cycle
2266 ----------
2267
2268 .. tabs::
2269
2270    .. group-tab:: C++
2271
2272       .. doxygenfunction:: simgrid::s4u::Exec::cancel
2273       .. doxygenfunction:: simgrid::s4u::Exec::start
2274       .. doxygenfunction:: simgrid::s4u::Exec::test
2275       .. doxygenfunction:: simgrid::s4u::Exec::wait
2276       .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2277       .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2278       .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2279
2280    .. group-tab:: Python
2281
2282        .. automethod:: simgrid.Exec.cancel
2283        .. automethod:: simgrid.Exec.start
2284        .. automethod:: simgrid.Exec.test
2285        .. automethod:: simgrid.Exec.wait
2286
2287    .. group-tab:: C
2288
2289        .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2290        .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2291        .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2292        .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2293        .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2294        .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2295        .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2296
2297 Signals
2298 -------
2299
2300 .. tabs::
2301
2302    .. group-tab:: C++
2303
2304       .. doxygenvariable:: simgrid::s4u::Exec::on_start
2305       .. doxygenvariable:: simgrid::s4u::Exec::on_completion
2306
2307 .. _API_s4u_Io:
2308
2309 ===========
2310 ⁣  class Io
2311 ===========
2312
2313 .. tabs::
2314
2315    .. group-tab:: C++
2316
2317       .. doxygenclass:: simgrid::s4u::Io
2318
2319    .. group-tab:: Python
2320
2321       .. autoclass:: simgrid.Io
2322
2323 Basic management
2324 ----------------
2325
2326 .. tabs::
2327
2328    .. group-tab:: C++
2329
2330       .. code-block:: C++
2331
2332          #include <simgrid/s4u/Io.hpp>
2333
2334       .. doxygentypedef:: IoPtr
2335
2336 Querying info
2337 -------------
2338
2339 .. tabs::
2340
2341    .. group-tab:: C++
2342
2343       .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2344       .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2345
2346 Life cycle
2347 ----------
2348
2349 .. tabs::
2350
2351    .. group-tab:: C++
2352
2353       .. doxygenfunction:: simgrid::s4u::Io::cancel
2354       .. doxygenfunction:: simgrid::s4u::Io::start
2355       .. doxygenfunction:: simgrid::s4u::Io::test
2356       .. doxygenfunction:: simgrid::s4u::Io::wait
2357       .. doxygenfunction:: simgrid::s4u::Io::wait_for
2358       .. doxygenfunction:: simgrid::s4u::Io::wait_any
2359       .. doxygenfunction:: simgrid::s4u::Io::wait_any_for
2360
2361    .. group-tab:: Python
2362
2363       .. automethod:: simgrid.Io.test
2364       .. automethod:: simgrid.Io.wait
2365       .. automethod:: simgrid.Io.wait_any_for
2366       .. automethod:: simgrid.Io.wait_any
2367
2368 .. _API_s4u_Synchronizations:
2369
2370 =======================
2371 Synchronization Objects
2372 =======================
2373
2374 .. _API_s4u_Mutex:
2375
2376 ==============
2377 ⁣  Mutex
2378 ==============
2379
2380 .. doxygenclass:: simgrid::s4u::Mutex
2381
2382 Basic management
2383 ----------------
2384
2385    .. tabs::
2386
2387       .. group-tab:: C++
2388
2389          .. code-block:: C++
2390
2391             #include <simgrid/s4u/Mutex.hpp>
2392
2393          .. doxygentypedef:: MutexPtr
2394
2395          .. doxygenfunction:: simgrid::s4u::Mutex::create()
2396
2397       .. group-tab:: C
2398
2399          .. code-block:: C
2400
2401             #include <simgrid/mutex.h>
2402
2403          .. doxygentypedef:: sg_mutex_t
2404          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2405
2406             Pointer to a constant mutex object.
2407
2408          .. doxygenfunction:: sg_mutex_init()
2409          .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2410
2411 Locking
2412 -------
2413
2414    .. tabs::
2415
2416       .. group-tab:: C++
2417
2418          .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2419          .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2420          .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2421
2422       .. group-tab:: C
2423
2424          .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2425          .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2426          .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2427
2428 .. _API_s4u_Barrier:
2429
2430 ================
2431 ⁣  Barrier
2432 ================
2433
2434 .. doxygenclass:: simgrid::s4u::Barrier
2435
2436 .. tabs::
2437
2438    .. group-tab:: C++
2439
2440       .. code-block:: C++
2441
2442          #include <simgrid/s4u/Barrier.hpp>
2443
2444       .. doxygentypedef:: BarrierPtr
2445
2446       .. doxygenfunction:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2447       .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2448       .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2449
2450    .. group-tab:: C
2451
2452       .. code-block:: C
2453
2454          #include <simgrid/barrier.hpp>
2455
2456       .. doxygentypedef:: sg_bar_t
2457       .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2458
2459          Pointer to a constant barrier object.
2460
2461       .. doxygenfunction:: sg_barrier_init(unsigned int count)
2462       .. doxygenfunction:: sg_barrier_destroy(const_sg_bar_t bar)
2463       .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2464
2465
2466 .. _API_s4u_ConditionVariable:
2467
2468 ==========================
2469 ⁣  Condition variable
2470 ==========================
2471
2472 .. doxygenclass:: simgrid::s4u::ConditionVariable
2473
2474 Basic management
2475 ----------------
2476
2477    .. tabs::
2478
2479       .. group-tab:: C++
2480
2481          .. code-block:: C++
2482
2483             #include <simgrid/s4u/ConditionVariable.hpp>
2484
2485          .. doxygentypedef:: ConditionVariablePtr
2486
2487          .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2488
2489       .. group-tab:: C
2490
2491          .. code-block:: C
2492
2493             #include <simgrid/cond.h>
2494
2495          .. doxygentypedef:: sg_cond_t
2496          .. doxygentypedef:: const_sg_cond_t
2497          .. doxygenfunction:: sg_cond_init
2498          .. doxygenfunction:: sg_cond_destroy
2499
2500 Waiting and notifying
2501 ---------------------
2502
2503    .. tabs::
2504
2505       .. group-tab:: C++
2506
2507          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2508          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2509          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2510          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2511          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2512          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2513          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2514          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2515          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2516          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2517          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2518          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2519          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2520
2521       .. group-tab:: C
2522
2523          .. doxygenfunction:: sg_cond_notify_all
2524          .. doxygenfunction:: sg_cond_notify_one
2525          .. doxygenfunction:: sg_cond_wait
2526          .. doxygenfunction:: sg_cond_wait_for
2527
2528 .. _API_s4u_Semaphore:
2529
2530 ==================
2531 ⁣  Semaphore
2532 ==================
2533
2534 .. doxygenclass:: simgrid::s4u::Semaphore
2535
2536
2537 Basic management
2538 ----------------
2539
2540    .. tabs::
2541
2542       .. group-tab:: C++
2543
2544          .. code-block:: C++
2545
2546             #include <simgrid/s4u/Semaphore.hpp>
2547
2548          .. doxygentypedef:: SemaphorePtr
2549          .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2550
2551       .. group-tab:: C
2552
2553          .. code-block:: C
2554
2555             #include <simgrid/semaphore.h>
2556
2557          .. doxygentypedef:: sg_sem_t
2558          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2559
2560             Pointer to a constant semaphore object.
2561
2562          .. doxygenfunction:: sg_sem_init(int initial_value)
2563          .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2564
2565 Locking
2566 -------
2567
2568    .. tabs::
2569
2570       .. group-tab:: C++
2571
2572          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2573          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2574          .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2575          .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2576          .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2577
2578       .. group-tab:: C
2579
2580          .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2581          .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2582          .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2583          .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2584          .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)
2585
2586 .. |hr| raw:: html
2587
2588    <hr />