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