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