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