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:: simgrid_get_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       .. doxygenfunction:: sg_hosts_as_dynar()
1223
1224 Modifying characteristics
1225 -------------------------
1226
1227 .. tabs::
1228
1229    .. group-tab:: C++
1230
1231       .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count)
1232       .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords)
1233       .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1234
1235    .. group-tab:: Python
1236
1237       .. automethod:: simgrid.Host.set_core_count
1238       .. automethod:: simgrid.Host.set_coordinates
1239       .. automethod:: simgrid.Host.set_sharing_policy
1240
1241 Querying info
1242 -------------
1243
1244 .. tabs::
1245
1246    .. group-tab:: C++
1247
1248       .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1249       .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1250       .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1251       .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1252       .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1253       .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1254
1255    .. group-tab:: Python
1256
1257       .. autoattribute:: simgrid.Host.name
1258       .. autoattribute:: simgrid.Host.load
1259       .. autoattribute:: simgrid.Host.pstate
1260       .. autoattribute:: simgrid.Host.speed
1261
1262    .. group-tab:: C
1263
1264       .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1265       .. doxygenfunction:: sg_host_dump(const_sg_host_t ws)
1266       .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1267       .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1268       .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1269
1270 User data and properties
1271 ------------------------
1272
1273 .. tabs::
1274
1275    .. group-tab:: C++
1276
1277       .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1278       .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1279       .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1280       .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1281
1282    .. group-tab:: C
1283
1284       .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1285       .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1286       .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1287       .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1288       .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1289
1290 Retrieving components
1291 ---------------------
1292
1293 .. tabs::
1294
1295    .. group-tab:: C++
1296
1297       .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1298       .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1299       .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1300       .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1301       .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1302
1303    .. group-tab:: Python
1304
1305       .. automethod:: simgrid.Host.get_disks
1306
1307    .. group-tab:: C
1308
1309       .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1310
1311 On/Off
1312 ------
1313
1314 .. tabs::
1315
1316    .. group-tab:: C++
1317
1318       .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1319       .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1320       .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1321
1322    .. group-tab:: C
1323
1324       .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1325       .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1326       .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1327
1328 DVFS
1329 ----
1330
1331 .. tabs::
1332
1333    .. group-tab:: C++
1334
1335       .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1336       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1337       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(unsigned long pstate_index) const
1338       .. doxygenfunction:: simgrid::s4u::Host::set_pstate(unsigned long pstate_index)
1339       .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1340       .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1341
1342    .. group-tab:: Python
1343
1344       .. automethod:: simgrid.Host.get_pstate_count
1345       .. automethod:: simgrid.Host.get_pstate_speed
1346
1347    .. group-tab:: C
1348
1349       .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1350       .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1351       .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1352       .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
1353       .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, unsigned long pstate)
1354
1355 Execution
1356 ---------
1357
1358 .. tabs::
1359
1360    .. group-tab:: C++
1361
1362       .. doxygenfunction:: simgrid::s4u::Host::exec_async
1363       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1364       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1365
1366 Platform and routing
1367 --------------------
1368
1369 You can also start direct communications between two arbitrary hosts
1370 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1371
1372 .. tabs::
1373
1374    .. group-tab:: C++
1375
1376       .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1377       .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1378       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1379       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
1380       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
1381       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
1382
1383    .. group-tab:: Python
1384
1385       .. automethod:: simgrid.Host.get_netpoint
1386       .. automethod:: simgrid.Host.create_disk
1387
1388    .. group-tab:: C
1389
1390       .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1391       .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1392       .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1393       .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1394
1395 Signals
1396 -------
1397
1398 .. tabs::
1399
1400    .. group-tab:: C++
1401
1402       .. doxygenvariable:: simgrid::s4u::Host::on_creation
1403       .. doxygenvariable:: simgrid::s4u::Host::on_destruction
1404       .. doxygenvariable:: simgrid::s4u::Host::on_speed_change
1405       .. doxygenvariable:: simgrid::s4u::Host::on_state_change
1406
1407 .. _API_s4u_Link:
1408
1409 =============
1410 ⁣  class Link
1411 =============
1412
1413 .. doxygenclass:: simgrid::s4u::Link
1414 .. doxygenclass:: simgrid::s4u::SplitDuplexLink
1415 .. doxygenclass:: simgrid::s4u::LinkInRoute
1416
1417 Basic management
1418 ----------------
1419
1420 .. tabs::
1421
1422    .. group-tab:: C++
1423
1424       .. code-block:: C++
1425
1426          #include <simgrid/s4u/Link.hpp>
1427
1428       Note that there is no LinkPtr type and that you cannot use the RAII
1429       idiom on hosts because SimGrid does not allow (yet) to create nor
1430       destroy resources once the simulation is started.
1431
1432       .. doxygenfunction:: simgrid::s4u::Link::seal()
1433
1434    .. group-tab:: Python
1435
1436       .. code:: Python
1437
1438          from simgrid import Link
1439
1440       .. automethod:: simgrid.Link.seal
1441
1442    .. group-tab:: C
1443
1444       .. code:: C
1445
1446          #include <simgrid/link.h>
1447
1448       .. doxygentypedef:: sg_link_t
1449       .. cpp:type:: const s4u_Link* const_sg_link_t
1450
1451          Pointer to a constant link object.
1452
1453 Retrieving links
1454 ----------------
1455
1456 .. tabs::
1457
1458    .. group-tab:: C++
1459
1460       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1461
1462       .. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
1463       .. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1464
1465    .. group-tab:: Python
1466
1467       .. autoattribute:: simgrid.Link.name
1468
1469    .. group-tab:: C
1470
1471       .. doxygenfunction:: sg_link_by_name(const char *name)
1472       .. doxygenfunction:: sg_link_count()
1473       .. doxygenfunction:: sg_link_list()
1474
1475 Querying info
1476 --------------
1477
1478 .. tabs::
1479
1480    .. group-tab:: C++
1481
1482       .. doxygenfunction:: simgrid::s4u::Link::get_bandwidth() const
1483       .. doxygenfunction:: simgrid::s4u::Link::get_cname() const
1484       .. doxygenfunction:: simgrid::s4u::Link::get_latency() const
1485       .. doxygenfunction:: simgrid::s4u::Link::get_name() const
1486       .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const
1487       .. doxygenfunction:: simgrid::s4u::Link::get_usage() const
1488       .. doxygenfunction:: simgrid::s4u::Link::is_used() const
1489
1490    .. group-tab:: C
1491
1492       .. doxygenfunction:: sg_link_get_bandwidth(const_sg_link_t link)
1493       .. doxygenfunction:: sg_link_get_latency(const_sg_link_t link)
1494       .. doxygenfunction:: sg_link_get_name(const_sg_link_t link)
1495       .. doxygenfunction:: sg_link_is_shared(const_sg_link_t link)
1496
1497 Modifying characteristics
1498 -------------------------
1499
1500 .. tabs::
1501
1502    .. group-tab:: C++
1503
1504       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
1505       .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
1506       .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value)
1507       .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit)
1508       .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {})
1509
1510    .. group-tab:: Python
1511
1512       .. automethod:: simgrid.Link.set_latency
1513       .. automethod:: simgrid.Link.set_concurrency_limit
1514       .. automethod:: simgrid.Link.set_sharing_policy
1515
1516    .. group-tab:: C
1517
1518       .. doxygenfunction:: sg_link_set_bandwidth(sg_link_t link, double value)
1519       .. doxygenfunction:: sg_link_set_latency(sg_link_t link, double value)
1520
1521 User data and properties
1522 ------------------------
1523
1524 .. tabs::
1525
1526    .. group-tab:: C++
1527
1528       .. doxygenfunction:: simgrid::s4u::Link::get_property(const std::string &key) const
1529       .. doxygenfunction:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1530
1531    .. group-tab:: C
1532
1533       .. doxygenfunction:: sg_link_get_data(const_sg_link_t link)
1534       .. doxygenfunction:: sg_link_set_data(sg_link_t link, void *data)
1535
1536 On/Off
1537 ------
1538
1539 .. tabs::
1540
1541    .. group-tab:: C++
1542
1543       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1544
1545       .. doxygenfunction:: simgrid::s4u::Link::is_on() const
1546       .. doxygenfunction:: simgrid::s4u::Link::turn_off()
1547       .. doxygenfunction:: simgrid::s4u::Link::turn_on()
1548
1549 Dynamic profiles
1550 ----------------
1551
1552 See :ref:`howto_churn` for more details.
1553
1554 .. tabs::
1555
1556    .. group-tab:: C++
1557
1558       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1559       .. doxygenfunction:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1560       .. doxygenfunction:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1561
1562 WIFI links
1563 ----------
1564
1565 .. tabs::
1566
1567    .. group-tab:: C++
1568
1569       .. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
1570
1571    .. group-tab:: Python
1572
1573       .. automethod:: simgrid.Link.set_host_wifi_rate
1574
1575 Signals
1576 -------
1577
1578 .. tabs::
1579
1580    .. group-tab:: C++
1581
1582       .. doxygenvariable:: simgrid::s4u::Link::on_bandwidth_change
1583       .. doxygenvariable:: simgrid::s4u::Link::on_communicate
1584       .. doxygenvariable:: simgrid::s4u::Link::on_communication_state_change
1585       .. doxygenvariable:: simgrid::s4u::Link::on_creation
1586       .. doxygenvariable:: simgrid::s4u::Link::on_destruction
1587       .. doxygenvariable:: simgrid::s4u::Link::on_state_change
1588
1589 .. _API_s4u_NetZone:
1590
1591 ================
1592 ⁣  class NetZone
1593 ================
1594
1595 .. doxygenclass:: simgrid::s4u::NetZone
1596
1597 Basic management
1598 ----------------
1599
1600 .. tabs::
1601
1602    .. group-tab:: C++
1603
1604       .. code-block:: C++
1605
1606          #include <simgrid/s4u/NetZone.hpp>
1607
1608       Note that there is no NetZonePtr type and that you cannot use the RAII
1609       idiom on network zones because SimGrid does not allow (yet) to create nor
1610       destroy resources once the simulation is started.
1611
1612       .. doxygenfunction:: simgrid::s4u::NetZone::seal
1613
1614    .. group-tab:: Python
1615
1616       .. code:: Python
1617
1618          from simgrid import NetZone
1619
1620       .. autoclass:: simgrid.NetZone
1621       .. automethod:: simgrid.NetZone.seal
1622
1623    .. group-tab:: C
1624
1625       .. code:: C
1626
1627          #include <simgrid/zone.h>
1628
1629       .. doxygentypedef:: sg_netzone_t
1630       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1631
1632          Pointer to a constant network zone object.
1633
1634 Retrieving zones
1635 ----------------
1636
1637 .. tabs::
1638
1639    .. group-tab:: C++
1640
1641       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1642       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1643       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1644
1645    .. group-tab:: C
1646
1647       .. doxygenfunction:: sg_zone_get_by_name(const char *name)
1648       .. doxygenfunction:: sg_zone_get_root()
1649
1650 Querying info
1651 --------------
1652
1653 .. tabs::
1654
1655    .. group-tab:: C++
1656
1657       .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
1658       .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
1659       .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint()
1660
1661    .. group-tab:: Python
1662
1663       .. autoattribute:: simgrid.NetZone.name
1664       .. automethod:: simgrid.NetZone.get_netpoint
1665
1666    .. group-tab:: C
1667
1668       .. doxygenfunction:: sg_zone_get_name(const_sg_netzone_t zone)
1669
1670 User data and properties
1671 ------------------------
1672
1673 .. tabs::
1674
1675    .. group-tab:: C++
1676
1677       .. doxygenfunction:: simgrid::s4u::NetZone::get_properties() const
1678       .. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1679       .. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1680
1681    .. group-tab:: Python
1682
1683       .. automethod:: simgrid.NetZone.set_property
1684
1685    .. group-tab:: C
1686
1687       .. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1688       .. doxygenfunction:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1689
1690 Retrieving components
1691 ---------------------
1692
1693 .. tabs::
1694
1695    .. group-tab:: C++
1696
1697       .. doxygenfunction:: simgrid::s4u::NetZone::get_all_hosts() const
1698       .. doxygenfunction:: simgrid::s4u::NetZone::get_host_count() const
1699
1700    .. group-tab:: C
1701
1702       .. doxygenfunction:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1703
1704 Routing data
1705 ------------
1706
1707 .. tabs::
1708
1709    .. group-tab:: C++
1710
1711       .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1712       .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1713       .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
1714       .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1715       .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
1716       .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent)
1717
1718    .. group-tab:: Python
1719
1720       .. automethod:: simgrid.NetZone.add_route
1721       .. automethod:: simgrid.NetZone.set_parent
1722
1723    .. group-tab:: C
1724
1725       .. doxygenfunction:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1726
1727 Signals
1728 -------
1729
1730 .. tabs::
1731
1732   .. group-tab:: C++
1733
1734      .. doxygenvariable:: simgrid::s4u::NetZone::on_creation
1735      .. doxygenvariable:: simgrid::s4u::NetZone::on_seal
1736
1737 Creating resources
1738 ------------------
1739
1740 Zones
1741 ^^^^^
1742 .. tabs::
1743
1744   .. group-tab:: C++
1745
1746      .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name)
1747      .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name)
1748      .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name)
1749      .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache)
1750      .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name)
1751      .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name)
1752      .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name)
1753      .. doxygenfunction:: simgrid::s4u::create_torus_zone
1754      .. 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)
1755      .. 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)
1756
1757   .. group-tab:: Python
1758
1759      .. automethod:: simgrid.NetZone.create_full_zone
1760      .. automethod:: simgrid.NetZone.create_empty_zone
1761      .. automethod:: simgrid.NetZone.create_star_zone
1762      .. automethod:: simgrid.NetZone.create_dijkstra_zone
1763      .. automethod:: simgrid.NetZone.create_floyd_zone
1764      .. automethod:: simgrid.NetZone.create_vivaldi_zone
1765      .. automethod:: simgrid.NetZone.create_wifi_zone
1766      .. automethod:: simgrid.NetZone.create_torus_zone
1767      .. automethod:: simgrid.NetZone.create_fatTree_zone
1768      .. automethod:: simgrid.NetZone.create_dragonfly_zone
1769
1770 Hosts
1771 ^^^^^
1772
1773 .. tabs::
1774
1775   .. group-tab:: C++
1776
1777      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
1778      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed)
1779      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
1780      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed)
1781
1782   .. group-tab:: Python
1783
1784      .. automethod:: simgrid.NetZone.create_host
1785
1786 Links
1787 ^^^^^
1788
1789 .. tabs::
1790
1791   .. group-tab:: C++
1792
1793      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
1794      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth)
1795      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidthds)
1796      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth)
1797      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
1798      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
1799
1800   .. group-tab:: Python
1801
1802      .. automethod:: simgrid.NetZone.create_link
1803      .. automethod:: simgrid.NetZone.create_split_duplex_link
1804
1805 Router
1806 ^^^^^^
1807
1808 .. tabs::
1809
1810   .. group-tab:: C++
1811
1812      .. doxygenfunction:: simgrid::s4u::NetZone::create_router(const std::string& name)
1813
1814   .. group-tab:: Python
1815
1816      .. automethod:: simgrid.NetZone.create_router
1817
1818 .. _API_s4u_VirtualMachine:
1819
1820 =======================
1821 ⁣  class VirtualMachine
1822 =======================
1823
1824
1825 .. doxygenclass:: simgrid::s4u::VirtualMachine
1826
1827 Basic management
1828 ----------------
1829 .. tabs::
1830
1831    .. group-tab:: C++
1832
1833       .. code-block:: C++
1834
1835          #include <simgrid/s4u/VirtualMachine.hpp>
1836
1837       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1838       idiom on virtual machines. There is no good reason for that and should change in the future.
1839
1840    .. group-tab:: C
1841
1842       .. code:: C
1843
1844          #include <simgrid/vm.h>
1845
1846       .. doxygentypedef:: sg_vm_t
1847       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1848
1849          Pointer to a constant virtual machine object.
1850
1851 Creating VMs
1852 ------------
1853
1854 .. tabs::
1855
1856    .. group-tab:: C++
1857
1858       .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1859       .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1860       .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1861
1862    .. group-tab:: C
1863
1864       .. doxygenfunction:: sg_vm_create_core
1865       .. doxygenfunction:: sg_vm_create_multicore
1866       .. doxygenfunction:: sg_vm_destroy
1867
1868 Querying info
1869 --------------
1870
1871 .. tabs::
1872
1873    .. group-tab:: C++
1874
1875       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1876       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
1877       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
1878
1879       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1880       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1881       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1882
1883    .. group-tab:: C
1884
1885       .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
1886       .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
1887       .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1888
1889       .. doxygenfunction:: sg_vm_get_name
1890       .. doxygenfunction:: sg_vm_get_pm
1891       .. doxygenfunction:: sg_vm_is_created
1892       .. doxygenfunction:: sg_vm_is_running
1893       .. doxygenfunction:: sg_vm_is_suspended
1894
1895 Life cycle
1896 ----------
1897
1898 .. tabs::
1899
1900    .. group-tab:: C++
1901
1902       .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
1903       .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
1904       .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
1905       .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
1906
1907    .. group-tab:: C
1908
1909       .. doxygenfunction:: sg_vm_start
1910       .. doxygenfunction:: sg_vm_suspend
1911       .. doxygenfunction:: sg_vm_resume
1912       .. doxygenfunction:: sg_vm_shutdown
1913
1914 Signals
1915 -------
1916
1917 .. tabs::
1918
1919    .. group-tab:: C++
1920
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_start
2107
2108 .. _API_s4u_Exec:
2109
2110 =============
2111 ⁣  class Exec
2112 =============
2113
2114 .. doxygenclass:: simgrid::s4u::Exec
2115
2116 Basic management
2117 ----------------
2118
2119 .. tabs::
2120
2121    .. group-tab:: C++
2122
2123       .. code-block:: C++
2124
2125          #include <simgrid/s4u/Exec.hpp>
2126
2127       .. doxygentypedef:: ExecPtr
2128
2129    .. group-tab:: Python
2130
2131       .. code:: Python
2132
2133          from simgrid import Exec
2134
2135       .. autoclass:: simgrid.Exec
2136
2137    .. group-tab:: C
2138
2139       .. code-block:: C
2140
2141          #include <simgrid/exec.h>
2142
2143       .. doxygentypedef:: sg_exec_t
2144       .. doxygentypedef:: const_sg_exec_t
2145
2146 Querying info
2147 -------------
2148
2149 .. tabs::
2150
2151    .. group-tab:: C++
2152
2153       .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
2154       .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
2155       .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
2156       .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
2157       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining
2158       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
2159       .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
2160       .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
2161       .. doxygenfunction:: simgrid::s4u::Exec::set_host
2162       .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
2163
2164    .. group-tab:: Python
2165
2166       .. autoattribute:: simgrid.Exec.host
2167       .. autoattribute:: simgrid.Exec.remaining
2168       .. autoattribute:: simgrid.Exec.remaining_ratio
2169
2170    .. group-tab:: C
2171
2172       .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
2173       .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
2174       .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
2175       .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
2176       .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
2177       .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
2178
2179 Life cycle
2180 ----------
2181
2182 .. tabs::
2183
2184    .. group-tab:: C++
2185
2186       .. doxygenfunction:: simgrid::s4u::Exec::cancel
2187       .. doxygenfunction:: simgrid::s4u::Exec::start
2188       .. doxygenfunction:: simgrid::s4u::Exec::test
2189       .. doxygenfunction:: simgrid::s4u::Exec::wait
2190       .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2191       .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2192       .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2193
2194    .. group-tab:: Python
2195
2196        .. automethod:: simgrid.Exec.cancel
2197        .. automethod:: simgrid.Exec.start
2198        .. automethod:: simgrid.Exec.test
2199        .. automethod:: simgrid.Exec.wait
2200
2201    .. group-tab:: C
2202
2203        .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2204        .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2205        .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2206        .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2207        .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2208        .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2209        .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2210
2211 Signals
2212 -------
2213
2214 .. tabs::
2215
2216    .. group-tab:: C++
2217
2218       .. doxygenvariable:: simgrid::s4u::Exec::on_start
2219       .. doxygenvariable:: simgrid::s4u::Exec::on_completion
2220
2221 .. _API_s4u_Io:
2222
2223 ===========
2224 ⁣  class Io
2225 ===========
2226
2227 .. doxygenclass:: simgrid::s4u::Io
2228
2229 Basic management
2230 ----------------
2231
2232 .. tabs::
2233
2234    .. group-tab:: C++
2235
2236       .. code-block:: C++
2237
2238          #include <simgrid/s4u/Io.hpp>
2239
2240       .. doxygentypedef:: IoPtr
2241
2242 Querying info
2243 -------------
2244
2245 .. tabs::
2246
2247    .. group-tab:: C++
2248
2249       .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2250       .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2251
2252 Life cycle
2253 ----------
2254
2255 .. tabs::
2256
2257    .. group-tab:: C++
2258
2259       .. doxygenfunction:: simgrid::s4u::Io::cancel
2260       .. doxygenfunction:: simgrid::s4u::Io::start
2261       .. doxygenfunction:: simgrid::s4u::Io::test
2262       .. doxygenfunction:: simgrid::s4u::Io::wait
2263       .. doxygenfunction:: simgrid::s4u::Io::wait_for
2264       .. doxygenfunction:: simgrid::s4u::Io::wait_any
2265       .. doxygenfunction:: simgrid::s4u::Io::wait_any_for
2266
2267    .. group-tab:: Python
2268
2269       .. automethod:: simgrid.Io.test
2270       .. automethod:: simgrid.Io.wait
2271       .. automethod:: simgrid.Io.wait_any_for
2272       .. automethod:: simgrid.Io.wait_any
2273
2274 .. _API_s4u_Synchronizations:
2275
2276 =======================
2277 Synchronization Objects
2278 =======================
2279
2280 .. _API_s4u_Mutex:
2281
2282 ==============
2283 ⁣  Mutex
2284 ==============
2285
2286 .. doxygenclass:: simgrid::s4u::Mutex
2287
2288 Basic management
2289 ----------------
2290
2291    .. tabs::
2292
2293       .. group-tab:: C++
2294
2295          .. code-block:: C++
2296
2297             #include <simgrid/s4u/Mutex.hpp>
2298
2299          .. doxygentypedef:: MutexPtr
2300
2301          .. doxygenfunction:: simgrid::s4u::Mutex::create()
2302
2303       .. group-tab:: C
2304
2305          .. code-block:: C
2306
2307             #include <simgrid/mutex.h>
2308
2309          .. doxygentypedef:: sg_mutex_t
2310          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2311
2312             Pointer to a constant mutex object.
2313
2314          .. doxygenfunction:: sg_mutex_init()
2315          .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2316
2317 Locking
2318 -------
2319
2320    .. tabs::
2321
2322       .. group-tab:: C++
2323
2324          .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2325          .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2326          .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2327
2328       .. group-tab:: C
2329
2330          .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2331          .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2332          .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2333
2334 .. _API_s4u_Barrier:
2335
2336 ================
2337 ⁣  Barrier
2338 ================
2339
2340 .. doxygenclass:: simgrid::s4u::Barrier
2341
2342 .. tabs::
2343
2344    .. group-tab:: C++
2345
2346       .. code-block:: C++
2347
2348          #include <simgrid/s4u/Barrier.hpp>
2349
2350       .. doxygentypedef:: BarrierPtr
2351
2352       .. doxygenfunction:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2353       .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2354       .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2355
2356    .. group-tab:: C
2357
2358       .. code-block:: C
2359
2360          #include <simgrid/barrier.hpp>
2361
2362       .. doxygentypedef:: sg_bar_t
2363       .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2364
2365          Pointer to a constant barrier object.
2366
2367       .. doxygenfunction:: sg_barrier_init(unsigned int count)
2368       .. doxygenfunction:: sg_barrier_destroy(const_sg_bar_t bar)
2369       .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2370
2371
2372 .. _API_s4u_ConditionVariable:
2373
2374 ==========================
2375 ⁣  Condition variable
2376 ==========================
2377
2378 .. doxygenclass:: simgrid::s4u::ConditionVariable
2379
2380 Basic management
2381 ----------------
2382
2383    .. tabs::
2384
2385       .. group-tab:: C++
2386
2387          .. code-block:: C++
2388
2389             #include <simgrid/s4u/ConditionVariable.hpp>
2390
2391          .. doxygentypedef:: ConditionVariablePtr
2392
2393          .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2394
2395       .. group-tab:: C
2396
2397          .. code-block:: C
2398
2399             #include <simgrid/cond.h>
2400
2401          .. doxygentypedef:: sg_cond_t
2402          .. doxygentypedef:: const_sg_cond_t
2403          .. doxygenfunction:: sg_cond_init
2404          .. doxygenfunction:: sg_cond_destroy
2405
2406 Waiting and notifying
2407 ---------------------
2408
2409    .. tabs::
2410
2411       .. group-tab:: C++
2412
2413          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2414          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2415          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2416          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2417          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2418          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2419          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2420          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2421          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2422          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2423          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2424          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2425          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2426
2427       .. group-tab:: C
2428
2429          .. doxygenfunction:: sg_cond_notify_all
2430          .. doxygenfunction:: sg_cond_notify_one
2431          .. doxygenfunction:: sg_cond_wait
2432          .. doxygenfunction:: sg_cond_wait_for
2433
2434 .. _API_s4u_Semaphore:
2435
2436 ==================
2437 ⁣  Semaphore
2438 ==================
2439
2440 .. doxygenclass:: simgrid::s4u::Semaphore
2441
2442
2443 Basic management
2444 ----------------
2445
2446    .. tabs::
2447
2448       .. group-tab:: C++
2449
2450          .. code-block:: C++
2451
2452             #include <simgrid/s4u/Semaphore.hpp>
2453
2454          .. doxygentypedef:: SemaphorePtr
2455          .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2456
2457       .. group-tab:: C
2458
2459          .. code-block:: C
2460
2461             #include <simgrid/semaphore.h>
2462
2463          .. doxygentypedef:: sg_sem_t
2464          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2465
2466             Pointer to a constant semaphore object.
2467
2468          .. doxygenfunction:: sg_sem_init(int initial_value)
2469          .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2470
2471 Locking
2472 -------
2473
2474    .. tabs::
2475
2476       .. group-tab:: C++
2477
2478          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2479          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2480          .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2481          .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2482          .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2483
2484       .. group-tab:: C
2485
2486          .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2487          .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2488          .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2489          .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2490          .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)
2491
2492 .. |hr| raw:: html
2493
2494    <hr />