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 .. rst-class:: compact-list
  68
  69    - **Simulation Elements**
  70
  71       - :ref:`class Actor <API_s4u_Actor>`: Active entities executing your application.
  72       - :ref:`class Engine <API_s4u_Engine>`: Simulation engine (singleton).
  73       - :ref:`class Mailbox <API_s4u_Mailbox>`: Communication rendezvous, with which actors meet each other.
  74
  75    - **Resources**
  76
  77       - :ref:`class Disk <API_s4u_Disk>`: Resource on which actors can write and read data.
  78       - :ref:`class Host <API_s4u_Host>`: Actor location, providing computational power.
  79       - :ref:`class Link <API_s4u_Link>`: Interconnecting hosts.
  80       - :ref:`class NetZone <API_s4u_NetZone>`: Sub-region of the platform, containing resources (Hosts, Links, etc).
  81       - :ref:`class VirtualMachine <API_s4u_VirtualMachine>`: Execution containers that can be moved between Hosts.
  82
  83    - **Activities** (:ref:`class Activity <API_s4u_Activity>`): The things that actors can do on resources.
  84
  85       - :ref:`class Comm <API_s4u_Comm>`: Communication activity, started on Mailboxes and consuming links.
  86       - :ref:`class Exec <API_s4u_Exec>`: Computation activity, started on Host and consuming CPU resources.
  87       - :ref:`class Io <API_s4u_Io>`: I/O activity, started on and consuming disks.
  88
  89    - **Synchronization Objects**: Classical IPC that actors can use
  90
  91       - :ref:`class Barrier <API_s4u_Barrier>`
  92       - :ref:`class ConditionVariable <API_s4u_ConditionVariable>`
  93       - :ref:`class Mutex <API_s4u_Mutex>`
  94       - :ref:`class Semaphore <API_s4u_Semaphore>`
  95
  96 .. |API_s4u_Actors| replace:: **Actors**
  97 .. _API_s4u_Actors: #api-s4u-actor
  98
  99 .. |API_s4u_Activities| replace:: **Activities**
 100 .. _API_s4u_Activities: #api-s4u-activity
 101
 102 .. |API_s4u_Hosts| replace:: **Hosts**
 103 .. _API_s4u_Hosts: #api-s4u-host
 104
 105 .. |API_s4u_Links| replace:: **Links**
 106 .. _API_s4u_Links: #api-s4u-link
 107
 108 .. |API_s4u_Disks| replace:: **Disks**
 109 .. _API_s4u_Disks: #api-s4u-disk
 110
 111 .. |API_s4u_VirtualMachine| replace:: **VirtualMachines**
 112
 113 .. |API_s4u_Host| replace:: **Host**
 114
 115 .. |API_s4u_Mailbox| replace:: **Mailbox**
 116
 117 .. |API_s4u_Mailboxes| replace:: **Mailboxes**
 118 .. _API_s4u_Mailboxes: #s4u-mailbox
 119
 120 .. |API_s4u_NetZone| replace:: **NetZone**
 121
 122 .. |API_s4u_Barrier| replace:: **Barrier**
 123
 124 .. |API_s4u_Semaphore| replace:: **Semaphore**
 125
 126 .. |API_s4u_ConditionVariable| replace:: **ConditionVariable**
 127
 128 .. |API_s4u_Mutex| replace:: **Mutex**
 129
 130 .. _s4u_Activities:
 131
 132 Activities
 133 **********
 134
 135 Activities represent the actions that consume a resource, such as a
 136 :ref:`Comm <API_s4u_Comm>` that consumes the *transmitting power* of
 137 :ref:`Link <API_s4u_Link>` resources, or an :ref:`Exec <API_s4u_Exec>`
 138 that consumes the *computing power* of :ref:`Host <API_s4u_Host>` resources.
 139 See also the :ref:`full API <API_s4u_Activity>` below.
 140
 141 =======================
 142 Asynchronous Activities
 143 =======================
 144
 145 Every activity can be either **blocking** or **asynchronous**. For
 146 example, :cpp:func:`s4u::Mailbox::put() <simgrid::s4u::Mailbox::put>`
 147 and :cpp:func:`s4u::Mailbox::get() <simgrid::s4u::Mailbox::get>`
 148 create blocking communications: the actor is blocked until the
 149 completion of that communication. Asynchronous communications do not
 150 block the actor during their execution but progress on their own.
 151
 152 Once your asynchronous activity is started, you can test for its
 153 completion using :cpp:func:`s4u::Activity::test() <simgrid::s4u::Activity::test>`.
 154 This function returns ``true`` if the activity is completed already.
 155 You can also use :cpp:func:`s4u::Activity::wait() <simgrid::s4u::Activity::wait>`
 156 to block until the completion of the activity. To wait for at most a given amount of time,
 157 use  :cpp:func:`s4u::Activity::wait_for() <simgrid::s4u::Activity::wait_for>`.
 158 Finally, to wait at most until a specified time limit, use
 159 :cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
 160
 161 Every kind of activity can be asynchronous.
 162 :ref:`s4u::CommPtr <API_s4u_Comm>` are created with :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
 163 :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`;
 164 :ref:`s4u::IoPtr <API_s4u_Io>` are created with :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
 165 :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`; and
 166 :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
 167 :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
 168 In the future, it will become possible to have asynchronous IPC such as asynchronous mutex lock requests.
 169
 170 The following example shows how to have several concurrent
 171 communications ongoing.  First, you have to declare a vector in which
 172 we will store the ongoing communications. It is also useful to have a
 173 vector of mailboxes.
 174
 175 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
 176    :language: c++
 177    :start-after: init-begin
 178    :end-before: init-end
 179    :dedent: 2
 180
 181 Then, you start all the communications that should occur concurrently with
 182 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
 183 Finally, the actor waits for the completion of all of them at once
 184 with :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
 185
 186 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
 187    :language: c++
 188    :start-after: put-begin
 189    :end-before: put-end
 190    :dedent: 2
 191
 192 =====================
 193 Activities Life cycle
 194 =====================
 195
 196 Sometimes, you want to change the setting of an activity before it even starts.
 197
 198 .. todo:: write this section
 199
 200 .. _s4u_mailbox:
 201
 202 Mailboxes
 203 *********
 204
 205 Please also refer to the :ref:`API reference for s4u::Mailbox
 206 <API_s4u_Mailbox>`.
 207
 208 ===================
 209 What are Mailboxes?
 210 ===================
 211
 212 |API_s4u_Mailboxes|_ are rendezvous points for network communications,
 213 similar to URLs on which you could post and retrieve data. Actually,
 214 the mailboxes are not involved in the communication once it starts,
 215 but only to find the contact with which you want to communicate.
 216
 217 They are similar to many common things: The phone number, which allows
 218 the caller to find the receiver. The Twitter hashtag, which helps
 219 senders and receivers to find each other. In TCP, the pair
 220 ``{host name, host port}`` to which you can connect to find your peer.
 221 In HTTP, URLs through which the clients can connect to the servers.
 222 In ZeroMQ, the queues are used to match senders and receivers.
 223
 224 One big difference with most of these systems is that no actor is the
 225 exclusive owner of a mailbox, neither in sending nor in receiving.
 226 Many actors can send into and/or receive from the same mailbox.  TCP
 227 socket ports for example are shared on the sender side but exclusive
 228 on the receiver side (only one process can receive from a given socket
 229 at a given point of time).
 230
 231 A big difference with TCP sockets or MPI communications is that
 232 communications do not start right away after a
 233 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put>`, but wait
 234 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get>`.
 235 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
 236
 237 A big difference with Twitter hashtags is that SimGrid does not
 238 offer easy support to broadcast a given message to many
 239 receivers. So that would be like a Twitter tag where each message
 240 is consumed by the first receiver.
 241
 242 A big difference with the ZeroMQ queues is that you cannot filter
 243 on the data you want to get from the mailbox. To model such settings
 244 in SimGrid, you'd have one mailbox per potential topic, and subscribe
 245 to each topic individually with a
 246 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async>` on each mailbox.
 247 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any>`
 248 to get the first message on any of the mailboxes you are subscribed to.
 249
 250 The mailboxes are not located on the network, and you can access
 251 them without any latency. The network delays are only related to the
 252 location of the sender and receiver once the match between them is
 253 done on the mailbox. This is just like the phone number that you
 254 can use locally, and the geographical distance only comes into play
 255 once you start the communication by dialing this number.
 256
 257 =====================
 258 How to use Mailboxes?
 259 =====================
 260
 261 You can retrieve any existing mailbox from its name (which is a
 262 unique string, just like a Twitter tag). This results in a
 263 versatile tool that can be used to build many different
 264 situations.
 265
 266 To model classical socket communications, use "hostname:port" as
 267 mailbox names, and make sure that only one actor reads into a given
 268 mailbox. This does not make it easy to build a perfectly realistic
 269 model of the TCP sockets, but in most cases, this system is too
 270 cumbersome for your simulations anyway. You probably want something
 271 simpler, that turns out to be easy to build with the mailboxes.
 272
 273 Many SimGrid examples use a sort of yellow page system where the
 274 mailbox names are the name of the service (such as "worker",
 275 "master", or "reducer"). That way, you don't have to know where your
 276 peer is located to contact it. You don't even need its name. Its
 277 function is enough for that. This also gives you some sort of load
 278 balancing for free if more than one actor pulls from the mailbox:
 279 the first actor that can deal with the request will handle it.
 280
 281 =========================================
 282 How are put() and get() requests matched?
 283 =========================================
 284
 285 The matching algorithm simple: first come, first serve. When a new
 286 send arrives, it matches the oldest enqueued receive. If no receive is
 287 currently enqueued, then the incoming send is enqueued. As you can
 288 see, the mailbox cannot contain both send and receive requests: all
 289 enqueued requests must be of the same sort.
 290
 291 .. _s4u_receiving_actor:
 292
 293 ===========================
 294 Declaring a Receiving Actor
 295 ===========================
 296
 297 The last twist is that by default in the simulator, the data starts
 298 to be exchanged only when both the sender and the receiver are
 299 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 300 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
 301 In TCP, since you establish connections beforehand, the data starts to
 302 flow as soon as the sender posts it, even if the receiver did not post
 303 its :cpp:func:`put() <simgrid::s4u::Mailbox::put()>` yet.
 304
 305 To model this in SimGrid, you can declare a specific receiver to a
 306 given mailbox (with the function
 307 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
 308 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 309 posted to that mailbox will start as soon as possible, and the data
 310 will already be there on the receiver host when the receiver actor
 311 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
 312
 313 Note that being permanent receivers of a mailbox prevents actors to be
 314 garbage-collected. If your simulation creates many short-lived actors
 315 that are marked as permanent receiver, you should call
 316 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
 317 memory gets properly reclaimed. This call should be at the end of the
 318 actor's function, not in an on_exit callback.
 319
 320 ===============================
 321 Communicating without Mailboxes
 322 ===============================
 323
 324 Sometimes you don't want to simulate communications between actors as
 325 allowed by mailboxes, but you want to create a direct communication
 326 between two arbitrary hosts. This can arise when you write a
 327 high-level model of a centralized scheduler, or when you model direct
 328 communications such as one-sided communications in MPI or remote
 329 memory direct access in PGAS.
 330
 331 For that, :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`
 332 simulates a direct communication between the two specified hosts. No
 333 mailbox is used, and there is no rendezvous between actors. You can
 334 freely mix such direct communications and rendezvous-based
 335 communications. Alternatively, :cpp:func:`Comm::sendto_init()
 336 <simgrid::s4u::Comm::sendto_init()>` and
 337 :cpp:func:`Comm::sendto_async() <simgrid::s4u::Comm::sendto_async()>`
 338 create asynchronous direct communications.
 339
 340 .. _s4u_raii:
 341
 342 Memory Management
 343 *****************
 344
 345 For sake of simplicity, we use `RAII
 346 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 347 for many classes in S4U. This is an idiom where resources are automatically
 348 managed through the context. Provided that you never manipulate
 349 objects of type Foo directly but always FooPtr references (which are
 350 defined as `boost::intrusive_ptr
 351 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 352 <Foo>), you will never have to explicitly release the resource that
 353 you use nor to free the memory of unused objects.
 354 Here is a little example:
 355
 356 .. code-block:: cpp
 357
 358    void myFunc()
 359    {
 360      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 361
 362      mutex->lock();   // use the mutex as a simple reference
 363      //  bla bla
 364      mutex->unlock();
 365
 366    } // The mutex gets automatically freed because the only existing reference gets out of scope
 367
 368 Note that Mailboxes, Hosts, and Links are not handled through smart
 369 pointers (yet?). This means that it is currently impossible to destroy a
 370 mailbox or a link. You can still destroy a host (but probably
 371 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 372
 373 .. THE EXAMPLES
 374
 375 .. include:: ../../examples/README.rst
 376
 377 API Reference
 378 *************
 379
 380 .. _API_s4u_simulation_object:
 381
 382 ==================
 383 Simulation objects
 384 ==================
 385
 386 .. _API_s4u_Actor:
 387
 388 ==============
 389 ⁣  class Actor
 390 ==============
 391
 392 .. tabs::
 393
 394    .. group-tab:: C++
 395
 396       .. doxygenclass:: simgrid::s4u::Actor
 397
 398       .. doxygentypedef:: aid_t
 399
 400
 401    .. group-tab:: Python
 402
 403       .. autoclass:: simgrid.Actor
 404
 405 Basic management
 406 ----------------
 407
 408 .. tabs::
 409
 410    .. group-tab:: C++
 411
 412       .. code:: C++
 413
 414          #include <simgrid/s4u/Actor.hpp>
 415
 416       .. doxygentypedef:: ActorPtr
 417
 418    .. group-tab:: Python
 419
 420       .. code:: Python
 421
 422          from simgrid import Actor
 423
 424    .. group-tab:: C
 425
 426       .. code:: C
 427
 428          #include <simgrid/actor.h>
 429
 430       .. doxygentypedef:: sg_actor_t
 431       .. doxygentypedef:: const_sg_actor_t
 432       .. doxygenfunction:: sg_actor_ref
 433       .. doxygenfunction:: sg_actor_unref
 434
 435
 436 Creating actors
 437 ---------------
 438
 439 See also :ref:`the relevant example <s4u_ex_actors_create>`.
 440
 441 .. tabs::
 442
 443    .. group-tab:: C++
 444
 445       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 446       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 447       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 448       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 449
 450       .. doxygenfunction:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 451       .. doxygenfunction:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 452       .. doxygenfunction:: simgrid::s4u::Actor::set_stacksize
 453
 454    .. group-tab:: Python
 455
 456       .. automethod:: simgrid.Actor.create
 457
 458    .. group-tab:: C
 459
 460       .. doxygenfunction:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, char *const *argv)
 461       .. doxygenfunction:: sg_actor_init(const char *name, sg_host_t host)
 462       .. doxygenfunction:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char *const *argv)
 463       .. doxygenfunction:: sg_actor_set_stacksize
 464
 465       .. doxygenfunction:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 466       .. doxygenfunction:: sg_actor_detach()
 467
 468 Retrieving actors
 469 -----------------
 470
 471 .. tabs::
 472
 473    .. group-tab:: C++
 474
 475       .. doxygenfunction:: simgrid::s4u::Actor::by_pid(aid_t pid)
 476       .. doxygenfunction:: simgrid::s4u::Actor::self()
 477
 478    .. group-tab:: Python
 479
 480       .. automethod:: simgrid.Actor.by_pid
 481       .. automethod:: simgrid.Actor.self
 482
 483    .. group-tab:: C
 484
 485       .. doxygenfunction:: sg_actor_by_pid(aid_t pid)
 486       .. doxygenfunction:: sg_actor_self()
 487       .. doxygenfunction:: sg_actor_list()
 488
 489 Querying info
 490 -------------
 491
 492 .. tabs::
 493
 494    .. group-tab:: C++
 495
 496       .. doxygenfunction:: simgrid::s4u::Actor::get_cname
 497       .. doxygenfunction:: simgrid::s4u::Actor::get_name
 498       .. doxygenfunction:: simgrid::s4u::Actor::get_pid
 499       .. doxygenfunction:: simgrid::s4u::Actor::get_ppid
 500       .. doxygenfunction:: simgrid::s4u::Actor::get_properties() const
 501       .. doxygenfunction:: simgrid::s4u::Actor::get_property(const std::string &key) const
 502       .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 503
 504       .. doxygenfunction:: simgrid::s4u::Actor::get_host
 505       .. doxygenfunction:: simgrid::s4u::Actor::set_host
 506
 507       .. doxygenfunction:: simgrid::s4u::Actor::get_refcount
 508       .. doxygenfunction:: simgrid::s4u::Actor::get_impl
 509
 510    .. group-tab:: Python
 511
 512       .. autoattribute:: simgrid.Actor.name
 513       .. autoattribute:: simgrid.Actor.host
 514       .. autoattribute:: simgrid.Actor.pid
 515       .. autoattribute:: simgrid.Actor.ppid
 516
 517    .. group-tab:: C
 518
 519       .. doxygenfunction:: sg_actor_get_name(const_sg_actor_t actor)
 520       .. doxygenfunction:: sg_actor_get_pid(const_sg_actor_t actor)
 521       .. doxygenfunction:: sg_actor_get_ppid(const_sg_actor_t actor)
 522       .. doxygenfunction:: sg_actor_get_properties(const_sg_actor_t actor)
 523       .. doxygenfunction:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 524
 525       .. doxygenfunction:: sg_actor_get_host(const_sg_actor_t actor)
 526       .. doxygenfunction:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 527
 528       .. doxygenfunction:: sg_actor_get_data(const_sg_actor_t actor)
 529       .. doxygenfunction:: sg_actor_set_data(sg_actor_t actor, void *userdata)
 530
 531 Suspending and resuming actors
 532 ------------------------------
 533
 534 .. tabs::
 535
 536    .. group-tab:: C++
 537
 538       .. doxygenfunction:: simgrid::s4u::Actor::suspend()
 539       .. doxygenfunction:: simgrid::s4u::Actor::resume()
 540       .. doxygenfunction:: simgrid::s4u::Actor::is_suspended
 541
 542    .. group-tab:: Python
 543
 544       .. automethod:: simgrid.Actor.resume
 545       .. automethod:: simgrid.Actor.suspend
 546       .. automethod:: simgrid.Actor.is_suspended
 547
 548    .. group-tab:: C
 549
 550       .. doxygenfunction:: sg_actor_suspend(sg_actor_t actor)
 551       .. doxygenfunction:: sg_actor_resume(sg_actor_t actor)
 552       .. doxygenfunction:: sg_actor_is_suspended(const_sg_actor_t actor)
 553
 554 Specifying when actors should terminate
 555 ---------------------------------------
 556
 557 .. tabs::
 558
 559    .. group-tab:: C++
 560
 561       .. doxygenfunction:: simgrid::s4u::Actor::kill()
 562       .. doxygenfunction:: simgrid::s4u::Actor::kill_all()
 563       .. doxygenfunction:: simgrid::s4u::Actor::set_kill_time(double time)
 564       .. doxygenfunction:: simgrid::s4u::Actor::get_kill_time
 565
 566       .. doxygenfunction:: simgrid::s4u::Actor::restart()
 567       .. doxygenfunction:: simgrid::s4u::Actor::daemonize()
 568       .. doxygenfunction:: simgrid::s4u::Actor::is_daemon
 569
 570    .. group-tab:: Python
 571
 572       .. automethod:: simgrid.Actor.kill
 573       .. automethod:: simgrid.Actor.kill_all
 574
 575       .. automethod:: simgrid.Actor.daemonize
 576       .. automethod:: simgrid.Actor.is_daemon
 577
 578    .. group-tab:: C
 579
 580       .. doxygenfunction:: sg_actor_kill(sg_actor_t actor)
 581       .. doxygenfunction:: sg_actor_kill_all()
 582       .. doxygenfunction:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 583
 584       .. doxygenfunction:: sg_actor_restart(sg_actor_t actor)
 585       .. doxygenfunction:: sg_actor_daemonize(sg_actor_t actor)
 586       .. doxygenfunction:: sg_actor_is_daemon
 587
 588 .. _API_s4u_Actor_end:
 589
 590 Reacting to the end of actors
 591 -----------------------------
 592
 593 .. tabs::
 594
 595    .. group-tab:: C++
 596
 597       .. doxygenfunction:: simgrid::s4u::Actor::on_exit
 598       .. doxygenfunction:: simgrid::s4u::Actor::join() const
 599       .. doxygenfunction:: simgrid::s4u::Actor::join(double timeout) const
 600       .. doxygenfunction:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 601       .. doxygenfunction:: simgrid::s4u::Actor::get_restart_count
 602
 603    .. group-tab:: Python
 604
 605       .. automethod:: simgrid.Actor.join
 606
 607    .. group-tab:: C
 608
 609       .. doxygenfunction:: sg_actor_on_exit
 610       .. doxygenfunction:: sg_actor_join(const_sg_actor_t actor, double timeout)
 611       .. doxygenfunction:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 612
 613 Signals
 614 -------
 615
 616 .. tabs::
 617
 618    .. group-tab:: C++
 619
 620       .. doxygenfunction:: simgrid::s4u::Actor::on_creation_cb
 621       .. doxygenfunction:: simgrid::s4u::Actor::on_suspend_cb
 622       .. doxygenfunction:: simgrid::s4u::Actor::on_host_change_cb
 623       .. doxygenfunction:: simgrid::s4u::Actor::on_resume_cb
 624       .. doxygenfunction:: simgrid::s4u::Actor::on_sleep_cb
 625       .. doxygenfunction:: simgrid::s4u::Actor::on_wake_up_cb
 626       .. doxygenfunction:: simgrid::s4u::Actor::on_termination_cb
 627       .. doxygenfunction:: simgrid::s4u::Actor::on_destruction_cb
 628
 629 .. _API_s4u_this_actor:
 630
 631 ====================
 632 ⁣  The current actor
 633 ====================
 634
 635 These functions can be used in your user code to interact with the actor
 636 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 637 Using these functions can greatly improve the code readability.
 638
 639 Querying info
 640 -------------
 641
 642 .. tabs::
 643
 644    .. group-tab:: C++
 645
 646       .. doxygenfunction:: simgrid::s4u::this_actor::get_cname()
 647       .. doxygenfunction:: simgrid::s4u::this_actor::get_name()
 648       .. doxygenfunction:: simgrid::s4u::this_actor::get_pid()
 649       .. doxygenfunction:: simgrid::s4u::this_actor::get_ppid()
 650       .. doxygenfunction:: simgrid::s4u::this_actor::is_maestro()
 651
 652       .. doxygenfunction:: simgrid::s4u::this_actor::get_host()
 653       .. doxygenfunction:: simgrid::s4u::this_actor::set_host(Host *new_host)
 654
 655    .. group-tab:: Python
 656
 657       .. autofunction:: simgrid.this_actor.get_host
 658       .. autofunction:: simgrid.this_actor.set_host
 659
 660       .. autofunction:: simgrid.this_actor.get_pid
 661       .. autofunction:: simgrid.this_actor.get_ppid
 662
 663    .. group-tab:: C
 664
 665       .. doxygenfunction:: sg_actor_self_get_data()
 666       .. doxygenfunction:: sg_actor_self_set_data(void *data)
 667       .. doxygenfunction:: sg_actor_self_get_name()
 668       .. doxygenfunction:: sg_actor_self_get_pid()
 669       .. doxygenfunction:: sg_actor_self_get_ppid()
 670       .. doxygenfunction:: sg_host_self()
 671       .. doxygenfunction:: sg_host_self_get_name()
 672
 673 Suspending and resuming
 674 -----------------------
 675
 676 .. tabs::
 677
 678    .. group-tab:: C++
 679
 680       .. doxygenfunction:: simgrid::s4u::this_actor::suspend()
 681       .. doxygenfunction:: simgrid::s4u::this_actor::yield()
 682
 683    .. group-tab:: Python
 684
 685       .. autofunction:: simgrid.this_actor.suspend
 686       .. autofunction:: simgrid.this_actor.yield_
 687
 688    .. group-tab:: C
 689
 690       .. doxygenfunction:: sg_actor_yield()
 691
 692 Logging messages
 693 ----------------
 694
 695 .. tabs::
 696
 697    .. group-tab:: C++
 698
 699       Please refer to :ref:`the relevant documentation <logging_prog>`.
 700
 701    .. group-tab:: Python
 702
 703        .. autofunction:: simgrid.this_actor.debug
 704        .. autofunction:: simgrid.this_actor.info
 705        .. autofunction:: simgrid.this_actor.warning
 706        .. autofunction:: simgrid.this_actor.error
 707
 708 Sleeping
 709 --------
 710
 711 .. tabs::
 712
 713    .. group-tab:: C++
 714
 715       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(double duration)
 716       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
 717       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
 718       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
 719
 720    .. group-tab:: Python
 721
 722       .. autofunction:: simgrid.this_actor.sleep_for
 723       .. autofunction:: simgrid.this_actor.sleep_until
 724
 725    .. group-tab:: C
 726
 727       .. doxygenfunction:: sg_actor_sleep_for(double duration)
 728
 729 Simulating executions
 730 ---------------------
 731
 732 Simulate the execution of some code on this actor. You can either simulate
 733 parallel or sequential code and you can either block upon the termination of
 734 the execution, or start an asynchronous activity.
 735
 736 .. tabs::
 737
 738    .. group-tab:: C++
 739
 740       .. doxygenfunction:: simgrid::s4u::this_actor::exec_async
 741       .. 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)
 742       .. doxygenfunction:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
 743       .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop)
 744       .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop, double priority)
 745       .. 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)
 746       .. doxygenfunction:: simgrid::s4u::this_actor::thread_execute
 747
 748    .. group-tab:: Python
 749
 750       .. autofunction:: simgrid.this_actor.exec_init
 751       .. autofunction:: simgrid.this_actor.execute
 752
 753    .. group-tab:: C
 754
 755       .. doxygenfunction:: sg_actor_execute(double flops)
 756       .. doxygenfunction:: sg_actor_execute_with_priority(double flops, double priority)
 757       .. doxygenfunction:: sg_actor_exec_init(double computation_amount)
 758       .. doxygenfunction:: sg_actor_exec_async(double computation_amount)
 759       .. doxygenfunction:: sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount, double* bytes_amount);
 760
 761 Exiting
 762 -------
 763
 764 .. tabs::
 765
 766    .. group-tab:: C++
 767
 768       .. doxygenfunction:: simgrid::s4u::this_actor::exit()
 769       .. doxygenfunction:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 770
 771    .. group-tab:: Python
 772
 773       .. autofunction:: simgrid.this_actor.exit
 774       .. autofunction:: simgrid.this_actor.on_exit
 775
 776    .. group-tab:: c
 777
 778       See also :cpp:func:`sg_actor_on_exit`.
 779
 780       .. doxygenfunction:: sg_actor_exit
 781
 782 .. _API_s4u_Engine:
 783
 784 ====================
 785 ⁣  Simulation Engine
 786 ====================
 787
 788 .. tabs::
 789
 790    .. group-tab:: C++
 791
 792       .. doxygenclass:: simgrid::s4u::Engine
 793
 794    .. group-tab:: Python
 795
 796       .. autoclass:: simgrid.Engine
 797
 798 Engin initialization
 799 --------------------
 800
 801 .. tabs::
 802
 803    .. group-tab:: C++
 804
 805       .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 806       .. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
 807       .. doxygenfunction:: simgrid::s4u::Engine::shutdown()
 808       .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
 809
 810    .. group-tab:: Python
 811
 812        .. automethod:: simgrid.Engine.__init__
 813        .. autoattribute:: simgrid.Engine.instance
 814
 815    .. group-tab:: C
 816
 817       .. doxygenfunction:: simgrid_init
 818
 819 Simulation setup
 820 ----------------
 821
 822 .. tabs::
 823
 824    .. group-tab:: C++
 825
 826       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
 827       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
 828       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
 829       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
 830       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
 831
 832       .. doxygenfunction:: simgrid::s4u::Engine::load_deployment
 833       .. doxygenfunction:: simgrid::s4u::Engine::load_platform
 834       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name)
 835       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 836       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
 837       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
 838
 839       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
 840       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
 841       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
 842
 843    .. group-tab:: Python
 844
 845        .. automethod:: simgrid.Engine.load_deployment
 846        .. automethod:: simgrid.Engine.load_platform
 847        .. automethod:: simgrid.Engine.register_actor
 848
 849    .. group-tab:: C
 850
 851       .. doxygenfunction:: simgrid_load_deployment
 852       .. doxygenfunction:: simgrid_load_platform
 853       .. doxygenfunction:: simgrid_register_default
 854       .. doxygenfunction:: simgrid_register_function
 855
 856
 857 Run the simulation
 858 ------------------
 859
 860 .. tabs::
 861
 862    .. group-tab:: C++
 863
 864       .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
 865       .. doxygenfunction:: simgrid::s4u::Engine::run
 866       .. doxygenfunction:: simgrid::s4u::Engine::run_until
 867
 868    .. group-tab:: Python
 869
 870       .. autoattribute:: simgrid.Engine.clock
 871       .. automethod:: simgrid.Engine.run
 872       .. automethod:: simgrid.Engine.run_until
 873
 874    .. group-tab:: C
 875
 876       .. doxygenfunction:: simgrid_get_clock
 877       .. doxygenfunction:: simgrid_run
 878       .. doxygenfunction:: simgrid_run_until
 879
 880 Retrieving actors
 881 -----------------
 882
 883 .. tabs::
 884
 885    .. group-tab:: C++
 886
 887       .. doxygenfunction:: simgrid::s4u::Engine::get_actor_count
 888       .. doxygenfunction:: simgrid::s4u::Engine::get_all_actors
 889       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_actors
 890
 891    .. group-tab:: C
 892
 893       .. doxygenfunction:: sg_actor_count()
 894
 895 Retrieving hosts
 896 ----------------
 897
 898 .. tabs::
 899
 900    .. group-tab:: C++
 901
 902       .. doxygenfunction:: simgrid::s4u::Engine::get_all_hosts
 903       .. doxygenfunction:: simgrid::s4u::Engine::get_host_count
 904       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_hosts
 905       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name
 906       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name_or_null
 907
 908    .. group-tab:: Python
 909
 910       .. autoattribute:: simgrid.Engine.all_hosts
 911
 912    .. group-tab:: C
 913
 914       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 915
 916 Retrieving links
 917 ----------------
 918
 919 .. tabs::
 920
 921    .. group-tab:: C++
 922
 923       .. doxygenfunction:: simgrid::s4u::Engine::get_all_links
 924       .. doxygenfunction:: simgrid::s4u::Engine::get_link_count
 925       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_links
 926       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name
 927       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name_or_null
 928
 929    .. group-tab:: Python
 930
 931       .. autoattribute:: simgrid.Engine.all_links
 932
 933 Interacting with the routing
 934 ----------------------------
 935
 936 .. tabs::
 937
 938    .. group-tab:: C++
 939
 940       .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
 941       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
 942       .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
 943       .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
 944       .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
 945
 946    .. group-tab:: Python
 947
 948       .. autoattribute:: simgrid.Engine.all_netpoints
 949       .. autoattribute:: simgrid.Engine.netzone_root
 950       .. automethod:: simgrid.Engine.netpoint_by_name
 951       .. automethod:: simgrid.Engine.netzone_by_name
 952
 953 Signals
 954 -------
 955
 956 .. tabs::
 957
 958    .. group-tab:: C++
 959
 960       .. doxygenfunction:: simgrid::s4u::Engine::on_deadlock_cb
 961       .. doxygenfunction:: simgrid::s4u::Engine::on_platform_created_cb
 962       .. doxygenfunction:: simgrid::s4u::Engine::on_platform_creation_cb
 963       .. doxygenfunction:: simgrid::s4u::Engine::on_simulation_start_cb
 964       .. doxygenfunction:: simgrid::s4u::Engine::on_simulation_end_cb
 965       .. doxygenfunction:: simgrid::s4u::Engine::on_time_advance_cb
 966
 967 .. _API_s4u_Mailbox:
 968
 969 ================
 970 ⁣  class Mailbox
 971 ================
 972
 973 .. tabs::
 974
 975    .. group-tab:: C++
 976
 977       .. doxygenclass:: simgrid::s4u::Mailbox
 978
 979    .. group-tab:: Python
 980
 981       .. autoclass:: simgrid.Mailbox
 982
 983 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 984
 985 Basic management
 986 ----------------
 987
 988 .. tabs::
 989
 990    .. group-tab:: C++
 991
 992       .. code-block:: C++
 993
 994          #include <simgrid/s4u/Mailbox.hpp>
 995
 996       Note that there is no MailboxPtr type and that you cannot use the RAII
 997       idiom on mailboxes because they are internal objects to the simulation
 998       engine. Once created, there is no way to destroy a mailbox before the end
 999       of the simulation.
1000
1001       .. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
1002
1003    .. group-tab:: Python
1004
1005       .. code-block:: C++
1006
1007          #include <simgrid/mailbox.h>
1008
1009       .. automethod:: simgrid.Mailbox.by_name
1010
1011    .. group-tab:: C
1012
1013       .. code-block:: C
1014
1015          #include <simgrid/s4u/mailbox.h>
1016
1017       .. doxygentypedef:: sg_mailbox_t
1018       .. doxygentypedef:: const_sg_mailbox_t
1019
1020       .. doxygenfunction:: sg_mailbox_by_name(const char *alias)
1021
1022 Querying info
1023 -------------
1024
1025 .. tabs::
1026
1027    .. group-tab:: C++
1028
1029       .. doxygenfunction:: simgrid::s4u::Mailbox::get_cname
1030       .. doxygenfunction:: simgrid::s4u::Mailbox::get_name
1031
1032    .. group-tab:: Python
1033
1034       .. autoattribute:: simgrid.Mailbox.name
1035
1036 Sending data
1037 ------------
1038
1039 .. tabs::
1040
1041    .. group-tab:: C++
1042
1043       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
1044       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
1045       .. doxygenfunction:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
1046       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init()
1047       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
1048
1049    .. group-tab:: Python
1050
1051       .. automethod:: simgrid.Mailbox.put
1052       .. automethod:: simgrid.Mailbox.put_async
1053       .. automethod:: simgrid.Mailbox.put_init
1054
1055    .. group-tab:: C
1056
1057       .. doxygenfunction:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1058       .. doxygenfunction:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1059       .. doxygenfunction:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1060
1061
1062 Receiving data
1063 --------------
1064
1065 .. tabs::
1066
1067    .. group-tab:: C++
1068
1069       .. doxygenfunction:: simgrid::s4u::Mailbox::empty
1070       .. doxygenfunction:: simgrid::s4u::Mailbox::front
1071       .. doxygenfunction:: simgrid::s4u::Mailbox::get()
1072       .. doxygenfunction:: simgrid::s4u::Mailbox::get(double timeout)
1073       .. doxygenfunction:: simgrid::s4u::Mailbox::get_async(T **data)
1074       .. doxygenfunction:: simgrid::s4u::Mailbox::get_init()
1075       .. doxygenfunction:: simgrid::s4u::Mailbox::iprobe(int type, const std::function<bool(void *, void *, kernel::activity::CommImpl *)>& match_fun, void *data)
1076       .. doxygenfunction:: simgrid::s4u::Mailbox::listen
1077       .. doxygenfunction:: simgrid::s4u::Mailbox::ready
1078
1079    .. group-tab:: Python
1080
1081        .. automethod:: simgrid.Mailbox.get
1082        .. automethod:: simgrid.Mailbox.get_async
1083
1084    .. group-tab:: C
1085
1086       .. doxygenfunction:: sg_mailbox_get(sg_mailbox_t mailbox)
1087       .. doxygenfunction:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1088       .. doxygenfunction:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1089       .. doxygenfunction:: sg_mailbox_listen(const char *alias)
1090
1091 Receiving actor
1092 ---------------
1093
1094 See :ref:`s4u_receiving_actor`.
1095
1096 .. tabs::
1097
1098    .. group-tab:: C++
1099
1100       .. doxygenfunction:: simgrid::s4u::Mailbox::get_receiver
1101       .. doxygenfunction:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1102
1103    .. group-tab:: C
1104
1105       .. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
1106
1107 .. _API_s4u_Resource:
1108
1109 =========
1110 Resources
1111 =========
1112
1113 .. _API_s4u_Disk:
1114
1115 =============
1116 ⁣  class Disk
1117 =============
1118
1119 .. tabs::
1120
1121    .. group-tab:: C++
1122
1123       .. doxygenclass:: simgrid::s4u::Disk
1124
1125    .. group-tab:: Python
1126
1127       .. autoclass:: simgrid.Disk
1128
1129    .. group-tab:: C
1130
1131       .. doxygentypedef:: sg_disk_t
1132       .. doxygentypedef:: const_sg_disk_t
1133
1134 Basic management
1135 ----------------
1136
1137 .. tabs::
1138
1139    .. group-tab:: C++
1140
1141       .. code-block:: C++
1142
1143          #include <simgrid/s4u/Disk.hpp>
1144
1145       Note that there is no DiskPtr type and that you cannot use the RAII
1146       idiom on disks because SimGrid does not allow (yet) to create nor
1147       destroy resources once the simulation is started.
1148
1149       .. doxygenfunction:: simgrid::s4u::Disk::seal()
1150
1151    .. group-tab:: Python
1152
1153       .. code:: Python
1154
1155          from simgrid import Disk
1156
1157       .. automethod:: simgrid.Disk.seal
1158
1159
1160 Querying info
1161 -------------
1162
1163 .. tabs::
1164
1165    .. group-tab:: C++
1166
1167       .. doxygenfunction:: simgrid::s4u::Disk::get_cname() const
1168       .. doxygenfunction:: simgrid::s4u::Disk::get_host() const
1169       .. doxygenfunction:: simgrid::s4u::Disk::get_name() const
1170       .. doxygenfunction:: simgrid::s4u::Disk::get_properties() const
1171       .. doxygenfunction:: simgrid::s4u::Disk::get_property(const std::string &key) const
1172       .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
1173       .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
1174       .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1175       .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1176
1177    .. group-tab:: Python
1178
1179       .. autoattribute:: simgrid.Disk.name
1180       .. automethod:: simgrid.Disk.set_sharing_policy
1181
1182 I/O operations
1183 --------------
1184
1185 .. tabs::
1186
1187    .. group-tab:: C++
1188
1189       .. doxygenfunction:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type) const
1190       .. doxygenfunction:: simgrid::s4u::Disk::read(sg_size_t size) const
1191       .. doxygenfunction:: simgrid::s4u::Disk::read_async(sg_size_t size) const
1192       .. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
1193       .. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
1194
1195    .. group-tab:: Python
1196
1197       .. automethod:: simgrid.Disk.read
1198       .. automethod:: simgrid.Disk.read_async
1199       .. automethod:: simgrid.Disk.write
1200       .. automethod:: simgrid.Disk.write_async
1201
1202 Signals
1203 -------
1204
1205 .. tabs::
1206
1207    .. group-tab:: C++
1208
1209       .. doxygenfunction:: simgrid::s4u::Disk::on_creation_cb
1210       .. doxygenfunction:: simgrid::s4u::Disk::on_destruction_cb
1211       .. doxygenfunction:: simgrid::s4u::Disk::on_state_change_cb
1212
1213
1214 .. _API_s4u_Host:
1215
1216 =============
1217 ⁣  class Host
1218 =============
1219
1220 .. tabs::
1221
1222    .. group-tab:: C++
1223
1224       .. doxygenclass:: simgrid::s4u::Host
1225
1226    .. group-tab:: Python
1227
1228       .. autoclass:: simgrid.Host
1229
1230 Basic management
1231 ----------------
1232
1233 .. tabs::
1234
1235    .. group-tab:: C++
1236
1237       .. code-block:: C++
1238
1239          #include <simgrid/s4u/Host.hpp>
1240
1241       Note that there is no HostPtr type, and that you cannot use the RAII
1242       idiom on hosts because SimGrid does not allow (yet) to create nor
1243       destroy resources once the simulation is started.
1244
1245       .. doxygenfunction:: simgrid::s4u::Host::destroy()
1246       .. doxygenfunction:: simgrid::s4u::Host::seal()
1247
1248    .. group-tab:: Python
1249
1250       .. code:: Python
1251
1252          from simgrid import Host
1253
1254       .. automethod:: simgrid.Host.seal
1255
1256    .. group-tab:: C
1257
1258       .. code:: C
1259
1260          #include <simgrid/host.h>
1261
1262       .. doxygentypedef:: sg_host_t
1263       .. cpp:type:: const s4u_Host* const_sg_host_t
1264
1265          Pointer to a constant host object.
1266
1267 Retrieving hosts
1268 ----------------
1269
1270 .. tabs::
1271
1272    .. group-tab:: C++
1273
1274       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1275
1276       .. doxygenfunction:: simgrid::s4u::Host::by_name(const std::string &name)
1277       .. doxygenfunction:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1278       .. doxygenfunction:: simgrid::s4u::Host::current()
1279
1280    .. group-tab:: Python
1281
1282       See also :py:attr:`simgrid.Engine.all_hosts`.
1283
1284       .. automethod:: simgrid.Host.by_name
1285       .. automethod:: simgrid.Host.current
1286
1287    .. group-tab:: C
1288
1289       .. doxygenfunction:: sg_host_by_name(const char *name)
1290       .. doxygenfunction:: sg_host_count()
1291       .. doxygenfunction:: sg_host_list()
1292
1293 Modifying characteristics
1294 -------------------------
1295
1296 .. tabs::
1297
1298    .. group-tab:: C++
1299
1300       .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count)
1301       .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords)
1302       .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1303
1304    .. group-tab:: Python
1305
1306       .. autoattribute:: simgrid.Host.core_count
1307       .. automethod:: simgrid.Host.set_coordinates
1308       .. automethod:: simgrid.Host.set_sharing_policy
1309
1310 Querying info
1311 -------------
1312
1313 .. tabs::
1314
1315    .. group-tab:: C++
1316
1317       .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1318       .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1319       .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1320       .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1321       .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1322       .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1323
1324    .. group-tab:: Python
1325
1326       .. autoattribute:: simgrid.Host.name
1327       .. autoattribute:: simgrid.Host.core_count
1328       .. autoattribute:: simgrid.Host.load
1329       .. autoattribute:: simgrid.Host.pstate
1330       .. autoattribute:: simgrid.Host.speed
1331       .. autoattribute:: simgrid.Host.available_speed
1332
1333    .. group-tab:: C
1334
1335       .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1336       .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1337       .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1338       .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1339
1340 User data and properties
1341 ------------------------
1342
1343 .. tabs::
1344
1345    .. group-tab:: C++
1346
1347       .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1348       .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1349       .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1350       .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1351
1352    .. group-tab:: C
1353
1354       .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1355       .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1356       .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1357       .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1358       .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1359
1360 Retrieving components
1361 ---------------------
1362
1363 .. tabs::
1364
1365    .. group-tab:: C++
1366
1367       .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1368       .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1369       .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1370       .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1371       .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1372
1373    .. group-tab:: Python
1374
1375       .. automethod:: simgrid.Host.get_disks
1376
1377    .. group-tab:: C
1378
1379       .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1380
1381 On/Off
1382 ------
1383
1384 .. tabs::
1385
1386    .. group-tab:: C++
1387
1388       .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1389       .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1390       .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1391
1392    .. group-tab:: C
1393
1394       .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1395       .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1396       .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1397
1398 DVFS
1399 ----
1400
1401 .. tabs::
1402
1403    .. group-tab:: C++
1404
1405       .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1406       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1407       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(unsigned long pstate_index) const
1408       .. doxygenfunction:: simgrid::s4u::Host::set_pstate(unsigned long pstate_index)
1409
1410    .. group-tab:: Python
1411
1412       .. autoattribute:: simgrid.Host.pstate_count
1413       .. automethod:: simgrid.Host.pstate_speed
1414
1415    .. group-tab:: C
1416
1417       .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1418       .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1419       .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1420       .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
1421       .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, unsigned long pstate)
1422
1423 Dynamic profiles
1424 ----------------
1425
1426 .. tabs::
1427
1428    .. group-tab:: C++
1429
1430       .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1431       .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1432
1433    .. group-tab:: Python
1434
1435       .. automethod:: simgrid.Host.set_speed_profile
1436       .. automethod:: simgrid.Host.set_state_profile
1437
1438 Execution
1439 ---------
1440
1441 .. tabs::
1442
1443    .. group-tab:: C++
1444
1445       .. doxygenfunction:: simgrid::s4u::Host::exec_async
1446       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1447       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1448
1449 Platform and routing
1450 --------------------
1451
1452 You can also start direct communications between two arbitrary hosts
1453 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1454
1455 .. tabs::
1456
1457    .. group-tab:: C++
1458
1459       .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1460       .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1461       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1462       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::StandardLinkImpl * > &links, double *latency) const
1463       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
1464       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
1465
1466    .. group-tab:: Python
1467
1468       .. autoattribute:: simgrid.Host.netpoint
1469       .. automethod:: simgrid.Host.create_disk
1470
1471       .. automethod:: simgrid.Host.route_to
1472
1473    .. group-tab:: C
1474
1475       .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1476       .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1477       .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1478       .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1479
1480 Signals
1481 -------
1482
1483 .. tabs::
1484
1485    .. group-tab:: C++
1486
1487       .. doxygenfunction:: simgrid::s4u::Host::on_creation_cb
1488       .. doxygenfunction:: simgrid::s4u::Host::on_destruction_cb
1489       .. doxygenfunction:: simgrid::s4u::Host::on_speed_change_cb
1490       .. doxygenfunction:: simgrid::s4u::Host::on_state_change_cb
1491
1492 .. _API_s4u_Link:
1493
1494 =============
1495 ⁣  class Link
1496 =============
1497
1498 .. tabs::
1499
1500    .. group-tab:: C++
1501
1502       .. doxygenclass:: simgrid::s4u::Link
1503       .. doxygenclass:: simgrid::s4u::SplitDuplexLink
1504       .. doxygenclass:: simgrid::s4u::LinkInRoute
1505
1506
1507    .. group-tab:: Python
1508
1509       .. autoclass:: simgrid.Link
1510
1511 Basic management
1512 ----------------
1513
1514 .. tabs::
1515
1516    .. group-tab:: C++
1517
1518       .. code-block:: C++
1519
1520          #include <simgrid/s4u/Link.hpp>
1521
1522       Note that there is no LinkPtr type and that you cannot use the RAII
1523       idiom on hosts because SimGrid does not allow (yet) to create nor
1524       destroy resources once the simulation is started.
1525
1526       .. doxygenfunction:: simgrid::s4u::Link::seal()
1527
1528    .. group-tab:: Python
1529
1530       .. code:: Python
1531
1532          from simgrid import Link
1533
1534       .. automethod:: simgrid.Link.seal
1535
1536    .. group-tab:: C
1537
1538       .. code:: C
1539
1540          #include <simgrid/link.h>
1541
1542       .. doxygentypedef:: sg_link_t
1543       .. cpp:type:: const s4u_Link* const_sg_link_t
1544
1545          Pointer to a constant link object.
1546
1547 Retrieving links
1548 ----------------
1549
1550 .. tabs::
1551
1552    .. group-tab:: C++
1553
1554       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1555
1556       .. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
1557       .. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1558
1559    .. group-tab:: Python
1560
1561       See also :py:attr:`simgrid.Engine.all_links`.
1562
1563       .. automethod:: simgrid.Link.by_name
1564       .. autoattribute:: simgrid.Link.name
1565
1566    .. group-tab:: C
1567
1568       .. doxygenfunction:: sg_link_by_name(const char *name)
1569       .. doxygenfunction:: sg_link_count()
1570       .. doxygenfunction:: sg_link_list()
1571
1572 Querying info
1573 --------------
1574
1575 .. tabs::
1576
1577    .. group-tab:: C++
1578
1579       .. doxygenfunction:: simgrid::s4u::Link::get_bandwidth() const
1580       .. doxygenfunction:: simgrid::s4u::Link::get_cname() const
1581       .. doxygenfunction:: simgrid::s4u::Link::get_latency() const
1582       .. doxygenfunction:: simgrid::s4u::Link::get_name() const
1583       .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const
1584       .. doxygenfunction:: simgrid::s4u::Link::get_usage() const
1585       .. doxygenfunction:: simgrid::s4u::Link::is_used() const
1586
1587    .. group-tab:: Python
1588
1589       .. autoattribute:: simgrid.Link.bandwidth
1590       .. autoattribute:: simgrid.Link.latency
1591
1592    .. group-tab:: C
1593
1594       .. doxygenfunction:: sg_link_get_bandwidth(const_sg_link_t link)
1595       .. doxygenfunction:: sg_link_get_latency(const_sg_link_t link)
1596       .. doxygenfunction:: sg_link_get_name(const_sg_link_t link)
1597       .. doxygenfunction:: sg_link_is_shared(const_sg_link_t link)
1598
1599 Modifying characteristics
1600 -------------------------
1601
1602 .. tabs::
1603
1604    .. group-tab:: C++
1605
1606       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
1607       .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
1608       .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value)
1609       .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit)
1610       .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {})
1611
1612    .. group-tab:: Python
1613
1614       .. automethod:: simgrid.Link.set_bandwidth
1615       .. automethod:: simgrid.Link.set_latency
1616       .. automethod:: simgrid.Link.set_concurrency_limit
1617       .. automethod:: simgrid.Link.set_sharing_policy
1618
1619    .. group-tab:: C
1620
1621       .. doxygenfunction:: sg_link_set_bandwidth(sg_link_t link, double value)
1622       .. doxygenfunction:: sg_link_set_latency(sg_link_t link, double value)
1623
1624 User data and properties
1625 ------------------------
1626
1627 .. tabs::
1628
1629    .. group-tab:: C++
1630
1631       .. doxygenfunction:: simgrid::s4u::Link::get_property(const std::string &key) const
1632       .. doxygenfunction:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1633
1634    .. group-tab:: C
1635
1636       .. doxygenfunction:: sg_link_get_data(const_sg_link_t link)
1637       .. doxygenfunction:: sg_link_set_data(sg_link_t link, void *data)
1638
1639 On/Off
1640 ------
1641
1642 .. tabs::
1643
1644    .. group-tab:: C++
1645
1646       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1647
1648       .. doxygenfunction:: simgrid::s4u::Link::is_on() const
1649       .. doxygenfunction:: simgrid::s4u::Link::turn_off()
1650       .. doxygenfunction:: simgrid::s4u::Link::turn_on()
1651
1652    .. group-tab:: Python
1653
1654       See also :py:func:`simgrid.Link.set_state_profile`.
1655
1656       .. automethod:: simgrid.Link.is_on
1657       .. automethod:: simgrid.Link.turn_off
1658       .. automethod:: simgrid.Link.turn_on
1659
1660 Dynamic profiles
1661 ----------------
1662
1663 See :ref:`howto_churn` for more details.
1664
1665 .. tabs::
1666
1667    .. group-tab:: C++
1668
1669       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1670       .. doxygenfunction:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1671       .. doxygenfunction:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1672
1673    .. group-tab:: Python
1674
1675       .. automethod:: simgrid.Link.set_bandwidth_profile
1676       .. automethod:: simgrid.Link.set_latency_profile
1677       .. automethod:: simgrid.Link.set_state_profile
1678
1679 WIFI links
1680 ----------
1681
1682 .. tabs::
1683
1684    .. group-tab:: C++
1685
1686       .. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
1687
1688    .. group-tab:: Python
1689
1690       .. automethod:: simgrid.Link.set_host_wifi_rate
1691
1692 Signals
1693 -------
1694
1695 .. tabs::
1696
1697    .. group-tab:: C++
1698
1699       .. doxygenfunction:: simgrid::s4u::Link::on_bandwidth_change_cb
1700       .. doxygenfunction:: simgrid::s4u::Link::on_communication_state_change_cb
1701       .. doxygenfunction:: simgrid::s4u::Link::on_creation_cb
1702       .. doxygenfunction:: simgrid::s4u::Link::on_destruction_cb
1703       .. doxygenfunction:: simgrid::s4u::Link::on_state_change_cb
1704
1705 .. _API_s4u_NetZone:
1706
1707 ================
1708 ⁣  class NetZone
1709 ================
1710
1711 .. tabs::
1712
1713    .. group-tab:: C++
1714
1715       .. doxygenclass:: simgrid::s4u::NetZone
1716
1717    .. group-tab:: Python
1718
1719       .. autoclass:: simgrid.NetZone
1720
1721 Basic management
1722 ----------------
1723
1724 .. tabs::
1725
1726    .. group-tab:: C++
1727
1728       .. code-block:: C++
1729
1730          #include <simgrid/s4u/NetZone.hpp>
1731
1732       Note that there is no NetZonePtr type and that you cannot use the RAII
1733       idiom on network zones because SimGrid does not allow (yet) to create nor
1734       destroy resources once the simulation is started.
1735
1736       .. doxygenfunction:: simgrid::s4u::NetZone::seal
1737
1738    .. group-tab:: Python
1739
1740       .. code:: Python
1741
1742          from simgrid import NetZone
1743
1744       .. automethod:: simgrid.NetZone.seal
1745
1746    .. group-tab:: C
1747
1748       .. code:: C
1749
1750          #include <simgrid/zone.h>
1751
1752       .. doxygentypedef:: sg_netzone_t
1753       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1754
1755          Pointer to a constant network zone object.
1756
1757 Retrieving zones
1758 ----------------
1759
1760 .. tabs::
1761
1762    .. group-tab:: C++
1763
1764       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1765       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1766       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1767
1768    .. group-tab:: C
1769
1770       .. doxygenfunction:: sg_zone_get_by_name(const char *name)
1771       .. doxygenfunction:: sg_zone_get_root()
1772
1773 Querying info
1774 --------------
1775
1776 .. tabs::
1777
1778    .. group-tab:: C++
1779
1780       .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
1781       .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
1782       .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint()
1783
1784    .. group-tab:: Python
1785
1786       .. autoattribute:: simgrid.NetZone.name
1787       .. autoattribute:: simgrid.NetZone.netpoint
1788
1789    .. group-tab:: C
1790
1791       .. doxygenfunction:: sg_zone_get_name(const_sg_netzone_t zone)
1792
1793 User data and properties
1794 ------------------------
1795
1796 .. tabs::
1797
1798    .. group-tab:: C++
1799
1800       .. doxygenfunction:: simgrid::s4u::NetZone::get_properties() const
1801       .. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1802       .. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1803
1804    .. group-tab:: Python
1805
1806       .. automethod:: simgrid.NetZone.set_property
1807
1808    .. group-tab:: C
1809
1810       .. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1811       .. doxygenfunction:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1812
1813 Retrieving components
1814 ---------------------
1815
1816 .. tabs::
1817
1818    .. group-tab:: C++
1819
1820       .. doxygenfunction:: simgrid::s4u::NetZone::get_all_hosts() const
1821       .. doxygenfunction:: simgrid::s4u::NetZone::get_host_count() const
1822
1823    .. group-tab:: C
1824
1825       .. doxygenfunction:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1826
1827 Routing data
1828 ------------
1829
1830 .. tabs::
1831
1832    .. group-tab:: C++
1833
1834       .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1835       .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1836       .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
1837       .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1838       .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
1839       .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent)
1840
1841    .. group-tab:: Python
1842
1843       .. automethod:: simgrid.NetZone.add_route
1844       .. automethod:: simgrid.NetZone.set_parent
1845
1846    .. group-tab:: C
1847
1848       .. doxygenfunction:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1849
1850 Signals
1851 -------
1852
1853 .. tabs::
1854
1855   .. group-tab:: C++
1856
1857      .. doxygenfunction:: simgrid::s4u::NetZone::on_creation_cb
1858      .. doxygenfunction:: simgrid::s4u::NetZone::on_seal_cb
1859
1860 Creating resources
1861 ------------------
1862
1863 Zones
1864 ^^^^^
1865 .. tabs::
1866
1867   .. group-tab:: C++
1868
1869      .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name)
1870      .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name)
1871      .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name)
1872      .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache)
1873      .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name)
1874      .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name)
1875      .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name)
1876      .. doxygenfunction:: simgrid::s4u::create_torus_zone
1877      .. 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)
1878      .. 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)
1879
1880   .. group-tab:: Python
1881
1882      .. automethod:: simgrid.NetZone.create_full_zone
1883      .. automethod:: simgrid.NetZone.create_empty_zone
1884      .. automethod:: simgrid.NetZone.create_star_zone
1885      .. automethod:: simgrid.NetZone.create_dijkstra_zone
1886      .. automethod:: simgrid.NetZone.create_floyd_zone
1887      .. automethod:: simgrid.NetZone.create_vivaldi_zone
1888      .. automethod:: simgrid.NetZone.create_wifi_zone
1889      .. automethod:: simgrid.NetZone.create_torus_zone
1890      .. automethod:: simgrid.NetZone.create_fatTree_zone
1891      .. automethod:: simgrid.NetZone.create_dragonfly_zone
1892
1893 Hosts
1894 ^^^^^
1895
1896 .. tabs::
1897
1898   .. group-tab:: C++
1899
1900      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
1901      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed)
1902      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
1903      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed)
1904
1905   .. group-tab:: Python
1906
1907      .. automethod:: simgrid.NetZone.create_host
1908
1909 Links
1910 ^^^^^
1911
1912 .. tabs::
1913
1914   .. group-tab:: C++
1915
1916      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
1917      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth)
1918      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidthds)
1919      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth)
1920      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
1921      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
1922
1923   .. group-tab:: Python
1924
1925      .. automethod:: simgrid.NetZone.create_link
1926      .. automethod:: simgrid.NetZone.create_split_duplex_link
1927
1928 Router
1929 ^^^^^^
1930
1931 .. tabs::
1932
1933   .. group-tab:: C++
1934
1935      .. doxygenfunction:: simgrid::s4u::NetZone::create_router(const std::string& name)
1936
1937   .. group-tab:: Python
1938
1939      .. automethod:: simgrid.NetZone.create_router
1940
1941 .. _API_s4u_VirtualMachine:
1942
1943 =======================
1944 ⁣  class VirtualMachine
1945 =======================
1946
1947
1948 .. doxygenclass:: simgrid::s4u::VirtualMachine
1949
1950 Basic management
1951 ----------------
1952 .. tabs::
1953
1954    .. group-tab:: C++
1955
1956       .. code-block:: C++
1957
1958          #include <simgrid/s4u/VirtualMachine.hpp>
1959
1960       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1961       idiom on virtual machines. There is no good reason for that and should change in the future.
1962
1963    .. group-tab:: C
1964
1965       .. code:: C
1966
1967          #include <simgrid/vm.h>
1968
1969       .. doxygentypedef:: sg_vm_t
1970       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1971
1972          Pointer to a constant virtual machine object.
1973
1974 Creating VMs
1975 ------------
1976
1977 .. tabs::
1978
1979    .. group-tab:: C++
1980
1981       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount)
1982       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount, size_t ramsize)
1983       .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1984
1985    .. group-tab:: C
1986
1987       .. doxygenfunction:: sg_vm_create_core
1988       .. doxygenfunction:: sg_vm_create_multicore
1989       .. doxygenfunction:: sg_vm_destroy
1990
1991 Querying info
1992 --------------
1993
1994 .. tabs::
1995
1996    .. group-tab:: C++
1997
1998       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1999       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
2000       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
2001
2002       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
2003       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
2004       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
2005
2006    .. group-tab:: C
2007
2008       .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
2009       .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
2010       .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
2011
2012       .. doxygenfunction:: sg_vm_get_name
2013       .. doxygenfunction:: sg_vm_get_pm
2014       .. doxygenfunction:: sg_vm_is_created
2015       .. doxygenfunction:: sg_vm_is_running
2016       .. doxygenfunction:: sg_vm_is_suspended
2017
2018 Life cycle
2019 ----------
2020
2021 .. tabs::
2022
2023    .. group-tab:: C++
2024
2025       .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
2026       .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
2027       .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
2028       .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
2029
2030    .. group-tab:: C
2031
2032       .. doxygenfunction:: sg_vm_start
2033       .. doxygenfunction:: sg_vm_suspend
2034       .. doxygenfunction:: sg_vm_resume
2035       .. doxygenfunction:: sg_vm_shutdown
2036
2037 Signals
2038 -------
2039
2040 .. tabs::
2041
2042    .. group-tab:: C++
2043
2044       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_creation_cb
2045       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_destruction_cb
2046       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_migration_end_cb
2047       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_migration_start_cb
2048       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_resume_cb
2049       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_shutdown_cb
2050       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_start_cb
2051       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_started_cb
2052       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_suspend_cb
2053
2054 .. _API_s4u_Activity:
2055
2056 ==========
2057 Activities
2058 ==========
2059
2060 ==============
2061 class Activity
2062 ==============
2063
2064 .. doxygenclass:: simgrid::s4u::Activity
2065
2066 **Known subclasses:**
2067 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
2068 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
2069 :ref:`I/O <API_s4u_Io>` (started on and consuming disks).
2070 See also the :ref:`section on activities <s4u_Activities>` above.
2071
2072 Basic management
2073 ----------------
2074
2075 .. tabs::
2076
2077    .. group-tab:: C++
2078
2079       .. code-block:: C++
2080
2081          #include <simgrid/s4u/Activity.hpp>
2082
2083       .. doxygentypedef:: ActivityPtr
2084
2085 Querying info
2086 -------------
2087
2088 .. tabs::
2089
2090    .. group-tab:: C++
2091
2092       .. doxygenfunction:: simgrid::s4u::Activity::get_cname
2093       .. doxygenfunction:: simgrid::s4u::Activity::get_name
2094       .. doxygenfunction:: simgrid::s4u::Activity::get_remaining() const
2095       .. doxygenfunction:: simgrid::s4u::Activity::get_state() const
2096       .. doxygenfunction:: simgrid::s4u::Activity::set_remaining(double remains)
2097       .. doxygenfunction:: simgrid::s4u::Activity::set_state(Activity::State state)
2098
2099
2100 Activities life cycle
2101 ---------------------
2102
2103 .. tabs::
2104
2105    .. group-tab:: C++
2106
2107       .. doxygenfunction:: simgrid::s4u::Activity::start
2108       .. doxygenfunction:: simgrid::s4u::Activity::cancel
2109       .. doxygenfunction:: simgrid::s4u::Activity::test
2110       .. doxygenfunction:: simgrid::s4u::Activity::wait
2111       .. doxygenfunction:: simgrid::s4u::Activity::wait_for
2112       .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit)
2113       .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start()
2114
2115 Suspending and resuming an activity
2116 -----------------------------------
2117
2118 .. tabs::
2119
2120    .. group-tab:: C++
2121
2122       .. doxygenfunction:: simgrid::s4u::Activity::suspend
2123       .. doxygenfunction:: simgrid::s4u::Activity::resume
2124       .. doxygenfunction:: simgrid::s4u::Activity::is_suspended
2125
2126 .. _API_s4u_Comm:
2127
2128 =============
2129 ⁣  class Comm
2130 =============
2131
2132 .. tabs::
2133
2134    .. group-tab:: C++
2135
2136       .. doxygenclass:: simgrid::s4u::Comm
2137
2138    .. group-tab:: Python
2139
2140       .. autoclass:: simgrid.Comm
2141
2142 Basic management
2143 ----------------
2144
2145 .. tabs::
2146
2147    .. group-tab:: C++
2148
2149       .. code-block:: C++
2150
2151          #include <simgrid/s4u/Comm.hpp>
2152
2153       .. doxygentypedef:: CommPtr
2154
2155    .. group-tab:: Python
2156
2157       .. code:: Python
2158
2159          from simgrid import Comm
2160
2161    .. group-tab:: c
2162
2163       .. code:: c
2164
2165          #include <simgrid/comm.h>
2166
2167       .. doxygentypedef:: sg_comm_t
2168
2169 Querying info
2170 -------------
2171
2172 .. tabs::
2173
2174    .. group-tab:: C++
2175
2176       .. doxygenfunction:: simgrid::s4u::Comm::get_dst_data_size() const
2177       .. doxygenfunction:: simgrid::s4u::Comm::get_mailbox() const
2178       .. doxygenfunction:: simgrid::s4u::Comm::get_sender() const
2179       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff)
2180       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
2181       .. doxygenfunction:: simgrid::s4u::Comm::detach()
2182       .. doxygenfunction:: simgrid::s4u::Comm::detach(const std::function<void(void*)>& clean_function)
2183       .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(uint64_t bytes)
2184       .. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
2185       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
2186       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
2187       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data_size(size_t size)
2188
2189    .. group-tab:: Python
2190
2191       .. automethod:: simgrid.Comm.detach
2192
2193 Life cycle
2194 ----------
2195
2196 Most communications are created using :ref:`s4u_mailbox`, but you can
2197 also start direct communications as shown below.
2198
2199 .. tabs::
2200
2201    .. group-tab:: C++
2202
2203       .. doxygenfunction:: simgrid::s4u::Comm::sendto
2204       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init()
2205       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init(Host *from, Host *to)
2206       .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
2207
2208       .. doxygenfunction:: simgrid::s4u::Comm::cancel
2209       .. doxygenfunction:: simgrid::s4u::Comm::start
2210       .. doxygenfunction:: simgrid::s4u::Comm::test
2211       .. doxygenfunction:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr >& comms)
2212       .. doxygenfunction:: simgrid::s4u::Comm::wait
2213       .. doxygenfunction:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr >& comms)
2214       .. doxygenfunction:: simgrid::s4u::Comm::wait_all_for(const std::vector< CommPtr >& comms, double timeout)
2215       .. doxygenfunction:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr >& comms)
2216       .. doxygenfunction:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr >& comms, double timeout)
2217       .. doxygenfunction:: simgrid::s4u::Comm::wait_for
2218
2219    .. group-tab:: Python
2220
2221       .. automethod:: simgrid.Comm.test
2222       .. automethod:: simgrid.Comm.wait
2223       .. automethod:: simgrid.Comm.wait_for
2224       .. automethod:: simgrid.Comm.wait_all
2225       .. automethod:: simgrid.Comm.wait_all_for
2226       .. automethod:: simgrid.Comm.wait_any
2227       .. automethod:: simgrid.Comm.wait_any_for
2228
2229    .. group-tab:: C
2230
2231       .. doxygenfunction:: sg_comm_test
2232       .. doxygenfunction:: sg_comm_wait
2233       .. doxygenfunction:: sg_comm_wait_all
2234       .. doxygenfunction:: sg_comm_wait_any
2235
2236 Signals
2237 -------
2238
2239 .. tabs::
2240
2241    .. group-tab:: C++
2242
2243       .. doxygenfunction:: simgrid::s4u::Comm::on_start_cb
2244       .. doxygenfunction:: simgrid::s4u::Comm::on_completion_cb
2245       .. doxygenfunction:: simgrid::s4u::Comm::on_recv_cb
2246       .. doxygenfunction:: simgrid::s4u::Comm::on_send_cb
2247
2248 .. _API_s4u_Exec:
2249
2250 =============
2251 ⁣  class Exec
2252 =============
2253
2254 .. tabs::
2255
2256    .. group-tab:: C++
2257
2258       .. doxygenclass:: simgrid::s4u::Exec
2259
2260    .. group-tab:: Python
2261
2262       .. autoclass:: simgrid.Exec
2263
2264 Basic management
2265 ----------------
2266
2267 .. tabs::
2268
2269    .. group-tab:: C++
2270
2271       .. code-block:: C++
2272
2273          #include <simgrid/s4u/Exec.hpp>
2274
2275       .. doxygentypedef:: ExecPtr
2276
2277    .. group-tab:: Python
2278
2279       .. code:: Python
2280
2281          from simgrid import Exec
2282
2283    .. group-tab:: C
2284
2285       .. code-block:: C
2286
2287          #include <simgrid/exec.h>
2288
2289       .. doxygentypedef:: sg_exec_t
2290       .. doxygentypedef:: const_sg_exec_t
2291
2292 Querying info
2293 -------------
2294
2295 .. tabs::
2296
2297    .. group-tab:: C++
2298
2299       .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
2300       .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
2301       .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
2302       .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
2303       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining
2304       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
2305       .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
2306       .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
2307       .. doxygenfunction:: simgrid::s4u::Exec::set_host
2308       .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
2309
2310    .. group-tab:: Python
2311
2312       .. autoattribute:: simgrid.Exec.host
2313       .. autoattribute:: simgrid.Exec.remaining
2314       .. autoattribute:: simgrid.Exec.remaining_ratio
2315
2316    .. group-tab:: C
2317
2318       .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
2319       .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
2320       .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
2321       .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
2322       .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
2323       .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
2324
2325 Life cycle
2326 ----------
2327
2328 .. tabs::
2329
2330    .. group-tab:: C++
2331
2332       .. doxygenfunction:: simgrid::s4u::Exec::cancel
2333       .. doxygenfunction:: simgrid::s4u::Exec::start
2334       .. doxygenfunction:: simgrid::s4u::Exec::test
2335       .. doxygenfunction:: simgrid::s4u::Exec::wait
2336       .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2337       .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2338       .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2339
2340    .. group-tab:: Python
2341
2342        .. automethod:: simgrid.Exec.cancel
2343        .. automethod:: simgrid.Exec.start
2344        .. automethod:: simgrid.Exec.test
2345        .. automethod:: simgrid.Exec.wait
2346
2347    .. group-tab:: C
2348
2349        .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2350        .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2351        .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2352        .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2353        .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2354        .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2355        .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2356
2357 Signals
2358 -------
2359
2360 .. tabs::
2361
2362    .. group-tab:: C++
2363
2364       .. doxygenfunction:: simgrid::s4u::Exec::on_start_cb
2365       .. doxygenfunction:: simgrid::s4u::Exec::on_completion_cb
2366
2367 .. _API_s4u_Io:
2368
2369 ===========
2370 ⁣  class Io
2371 ===========
2372
2373 .. tabs::
2374
2375    .. group-tab:: C++
2376
2377       .. doxygenclass:: simgrid::s4u::Io
2378
2379    .. group-tab:: Python
2380
2381       .. autoclass:: simgrid.Io
2382
2383 Basic management
2384 ----------------
2385
2386 .. tabs::
2387
2388    .. group-tab:: C++
2389
2390       .. code-block:: C++
2391
2392          #include <simgrid/s4u/Io.hpp>
2393
2394       .. doxygentypedef:: IoPtr
2395
2396 Querying info
2397 -------------
2398
2399 .. tabs::
2400
2401    .. group-tab:: C++
2402
2403       .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2404       .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2405
2406 Life cycle
2407 ----------
2408
2409 .. tabs::
2410
2411    .. group-tab:: C++
2412
2413       .. doxygenfunction:: simgrid::s4u::Io::cancel
2414       .. doxygenfunction:: simgrid::s4u::Io::start
2415       .. doxygenfunction:: simgrid::s4u::Io::test
2416       .. doxygenfunction:: simgrid::s4u::Io::wait
2417       .. doxygenfunction:: simgrid::s4u::Io::wait_for
2418       .. doxygenfunction:: simgrid::s4u::Io::wait_any(const std::vector<IoPtr> &ios)
2419       .. doxygenfunction:: simgrid::s4u::Io::wait_any_for(const std::vector<IoPtr> &ios, double timeout)
2420
2421    .. group-tab:: Python
2422
2423       .. automethod:: simgrid.Io.test
2424       .. automethod:: simgrid.Io.wait
2425       .. automethod:: simgrid.Io.wait_any_for
2426       .. automethod:: simgrid.Io.wait_any
2427
2428 Signals
2429 -------
2430
2431 .. tabs::
2432
2433    .. group-tab:: C++
2434
2435       .. doxygenfunction:: simgrid::s4u::Io::on_start_cb
2436       .. doxygenfunction:: simgrid::s4u::Io::on_completion_cb
2437
2438 .. _API_s4u_Synchronizations:
2439
2440 =======================
2441 Synchronization Objects
2442 =======================
2443
2444 .. _API_s4u_Mutex:
2445
2446 ==============
2447 ⁣  Mutex
2448 ==============
2449
2450 .. tabs::
2451
2452    .. group-tab:: C++
2453
2454       .. doxygenclass:: simgrid::s4u::Mutex
2455
2456    .. group-tab:: Python
2457
2458       .. autoclass:: simgrid.Mutex
2459
2460 Basic management
2461 ----------------
2462
2463    .. tabs::
2464
2465       .. group-tab:: C++
2466
2467          .. code-block:: C++
2468
2469             #include <simgrid/s4u/Mutex.hpp>
2470
2471          .. doxygentypedef:: MutexPtr
2472
2473          .. doxygenfunction:: simgrid::s4u::Mutex::create()
2474
2475       .. group-tab:: Python
2476
2477          .. code-block:: Python
2478
2479             from simgrid import Mutex
2480             mutex = Mutex()
2481
2482             # Use a context manager to acquire and automatically release the mutex
2483             # when leaving the scope.
2484             with mutex:
2485                 # Access shared resource ...
2486                 pass
2487
2488          .. automethod:: simgrid.Mutex.__init__
2489
2490       .. group-tab:: C
2491
2492          .. code-block:: C
2493
2494             #include <simgrid/mutex.h>
2495
2496          .. doxygentypedef:: sg_mutex_t
2497          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2498
2499             Pointer to a constant mutex object.
2500
2501          .. doxygenfunction:: sg_mutex_init()
2502          .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2503
2504 Locking
2505 -------
2506
2507    .. tabs::
2508
2509       .. group-tab:: C++
2510
2511          .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2512          .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2513          .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2514
2515       .. group-tab:: Python
2516
2517          .. automethod:: simgrid.Mutex.lock
2518          .. automethod:: simgrid.Mutex.try_lock
2519          .. automethod:: simgrid.Mutex.unlock
2520
2521       .. group-tab:: C
2522
2523          .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2524          .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2525          .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2526
2527 .. _API_s4u_Barrier:
2528
2529 ================
2530 ⁣  Barrier
2531 ================
2532
2533 .. tabs::
2534
2535    .. group-tab:: C++
2536
2537       .. doxygenclass:: simgrid::s4u::Barrier
2538
2539    .. group-tab:: Python
2540
2541       .. autoclass:: simgrid.Barrier
2542
2543 .. tabs::
2544
2545    .. group-tab:: C++
2546
2547       .. code-block:: C++
2548
2549          #include <simgrid/s4u/Barrier.hpp>
2550
2551       .. doxygentypedef:: BarrierPtr
2552
2553       .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2554       .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2555
2556    .. group-tab:: Python
2557
2558       .. code-block:: Python
2559
2560          from simgrid import Barrier
2561          barrier = Barrier(2)
2562
2563       .. automethod:: simgrid.Barrier.__init__
2564       .. automethod:: simgrid.Barrier.wait
2565
2566    .. group-tab:: C
2567
2568       .. code-block:: C
2569
2570          #include <simgrid/barrier.hpp>
2571
2572       .. doxygentypedef:: sg_bar_t
2573
2574       .. doxygenfunction:: sg_barrier_init(unsigned int count)
2575       .. doxygenfunction:: sg_barrier_destroy(sg_bar_t bar)
2576       .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2577
2578
2579 .. _API_s4u_ConditionVariable:
2580
2581 ==========================
2582 ⁣  Condition variable
2583 ==========================
2584
2585 .. doxygenclass:: simgrid::s4u::ConditionVariable
2586
2587 Basic management
2588 ----------------
2589
2590    .. tabs::
2591
2592       .. group-tab:: C++
2593
2594          .. code-block:: C++
2595
2596             #include <simgrid/s4u/ConditionVariable.hpp>
2597
2598          .. doxygentypedef:: ConditionVariablePtr
2599
2600          .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2601
2602       .. group-tab:: C
2603
2604          .. code-block:: C
2605
2606             #include <simgrid/cond.h>
2607
2608          .. doxygentypedef:: sg_cond_t
2609          .. doxygentypedef:: const_sg_cond_t
2610          .. doxygenfunction:: sg_cond_init
2611          .. doxygenfunction:: sg_cond_destroy
2612
2613 Waiting and notifying
2614 ---------------------
2615
2616    .. tabs::
2617
2618       .. group-tab:: C++
2619
2620          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2621          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2622          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2623          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2624          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2625          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2626          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2627          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2628          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2629          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2630          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2631          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2632          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2633
2634       .. group-tab:: C
2635
2636          .. doxygenfunction:: sg_cond_notify_all
2637          .. doxygenfunction:: sg_cond_notify_one
2638          .. doxygenfunction:: sg_cond_wait
2639          .. doxygenfunction:: sg_cond_wait_for
2640
2641 .. _API_s4u_Semaphore:
2642
2643 ==================
2644 ⁣  Semaphore
2645 ==================
2646
2647 .. tabs::
2648
2649    .. group-tab:: C++
2650
2651       .. doxygenclass:: simgrid::s4u::Semaphore
2652
2653    .. group-tab:: Python
2654
2655       .. autoclass:: simgrid.Semaphore
2656
2657 Basic management
2658 ----------------
2659
2660    .. tabs::
2661
2662       .. group-tab:: C++
2663
2664          .. code-block:: C++
2665
2666             #include <simgrid/s4u/Semaphore.hpp>
2667
2668          .. doxygentypedef:: SemaphorePtr
2669          .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2670
2671       .. group-tab:: Python
2672
2673          .. code-block:: Python
2674
2675             from simgrid import Semaphore
2676             semaphore = Semaphore(1)
2677             # Automatically acquire the semaphore, and release it after leaving the scope.
2678             with semaphore:
2679                 # Do something with the shared resource
2680                 pass
2681
2682          .. automethod:: simgrid.Semaphore.__init__
2683
2684       .. group-tab:: C
2685
2686          .. code-block:: C
2687
2688             #include <simgrid/semaphore.h>
2689
2690          .. doxygentypedef:: sg_sem_t
2691          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2692
2693             Pointer to a constant semaphore object.
2694
2695          .. doxygenfunction:: sg_sem_init(int initial_value)
2696          .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2697
2698 Locking
2699 -------
2700
2701    .. tabs::
2702
2703       .. group-tab:: C++
2704
2705          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2706          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2707          .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2708          .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2709          .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2710
2711       .. group-tab:: Python
2712
2713          .. automethod:: simgrid.Semaphore.acquire
2714          .. automethod:: simgrid.Semaphore.acquire_timeout
2715          .. autoattribute:: simgrid.Semaphore.capacity
2716          .. automethod:: simgrid.Semaphore.release
2717          .. autoattribute:: simgrid.Semaphore.would_block
2718
2719       .. group-tab:: C
2720
2721          .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2722          .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2723          .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2724          .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2725          .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)
2726
2727 .. |hr| raw:: html
2728
2729    <hr />