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 definitely the way to go for long-term
  24 projects. It is feature complete, but may still evolve slightly in the
  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 rendez-vous 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 itself in a |API_s4u_NetZone|_, that knows the networking path between one
  58 resource to another. Each NetZone is included in another one, forming
  59 a tree of NetZones which root zone contains the whole platform. The
  60 actors can also be located on a |API_s4U_VirtualMachine|_ that may
  61 restrict the activities it contains to a limited amount of cores.
  62 Virtual machines can also be migrated between hosts.
  63
  64 The :ref:`simgrid::s4u::this_actor <API_s4u_this_actor>` namespace
  65 provides many helper functions to simplify the code of actors.
  66
  67 - **Simulation Elements**
  68
  69   - :ref:`class Actor <API_s4u_Actor>`:
  70     Active entities executing your application.
  71   - :ref:`class Engine <API_s4u_Engine>`
  72     Simulation engine (singleton).
  73   - :ref:`class Mailbox <API_s4u_Mailbox>`
  74     Communication rendez-vous, with which actors meet each other.
  75
  76 - **Resources**
  77
  78   - :ref:`class Disk <API_s4u_Disk>`
  79     Resource on which actors can write and read data.
  80   - :ref:`class Host <API_s4u_Host>`:
  81     Actor location, providing computational power.
  82   - :ref:`class Link <API_s4u_Link>`
  83     Interconnecting hosts.
  84   - :ref:`class NetZone <API_s4u_NetZone>`:
  85     Sub-region of the platform, containing resources (Hosts, Links, etc).
  86   - :ref:`class VirtualMachine <API_s4u_VirtualMachine>`:
  87     Execution containers that can be moved between Hosts.
  88
  89 - **Activities** (:ref:`class Activity <API_s4u_Activity>`):
  90   The things that actors can do on resources
  91
  92   - :ref:`class Comm <API_s4u_Comm>`
  93     Communication activity, started on Mailboxes and consuming links.
  94   - :ref:`class Exec <API_s4u_Exec>`
  95     Computation activity, started on Host and consuming CPU resources.
  96   - :ref:`class Io <API_s4u_Io>`
  97     I/O activity, started on and consumming disks.
  98
  99 - **Synchronization Objects**: Classical IPC that actors can use
 100
 101   - :ref:`class Barrier <API_s4u_Barrier>`
 102   - :ref:`class ConditionVariable <API_s4u_ConditionVariable>`
 103   - :ref:`class Mutex <API_s4u_Mutex>`
 104   - :ref:`class Semaphore <API_s4u_Semaphore>`
 105
 106
 107 .. |API_s4u_Actors| replace:: **Actors**
 108 .. _API_s4u_Actors: #api-s4u-actor
 109
 110 .. |API_s4u_Activities| replace:: **Activities**
 111 .. _API_s4u_Activities: #api-s4u-activity
 112
 113 .. |API_s4u_Hosts| replace:: **Hosts**
 114 .. _API_s4u_Hosts: #api-s4u-host
 115
 116 .. |API_s4u_Links| replace:: **Links**
 117 .. _API_s4u_Links: #api-s4u-link
 118
 119 .. |API_s4u_Disks| replace:: **Disks**
 120 .. _API_s4u_Disks: #api-s4u-disk
 121
 122 .. |API_s4u_VirtualMachine| replace:: **VirtualMachines**
 123
 124 .. |API_s4u_Host| replace:: **Host**
 125
 126 .. |API_s4u_Mailbox| replace:: **Mailbox**
 127
 128 .. |API_s4u_Mailboxes| replace:: **Mailboxes**
 129 .. _API_s4u_Mailboxes: #s4u-mailbox
 130
 131 .. |API_s4u_NetZone| replace:: **NetZone**
 132
 133 .. |API_s4u_Barrier| replace:: **Barrier**
 134
 135 .. |API_s4u_Semaphore| replace:: **Semaphore**
 136
 137 .. |API_s4u_ConditionVariable| replace:: **ConditionVariable**
 138
 139 .. |API_s4u_Mutex| replace:: **Mutex**
 140
 141 .. _s4u_Activities:
 142
 143 Activities
 144 **********
 145
 146 Activities represent the actions that consume a resource, such as a
 147 :ref:`Comm <API_s4u_Comm>` that consumes the *transmitting power* of
 148 :ref:`Link <API_s4u_Link>` resources, or an :ref:`Exec <API_s4u_Exec>`
 149 that consumes the *computing power* of :ref:`Host <API_s4u_Host>` resources.
 150 See also the :ref:`full API <API_s4u_Activity>` below.
 151
 152 =======================
 153 Asynchronous Activities
 154 =======================
 155
 156 Every activity can be either **blocking** or **asynchronous**. For
 157 example, :cpp:func:`s4u::Mailbox::put() <simgrid::s4u::Mailbox::put>`
 158 and :cpp:func:`s4u::Mailbox::get() <simgrid::s4u::Mailbox::get>`
 159 create blocking communications: the actor is blocked until the
 160 completion of that communication. Asynchronous communications do not
 161 block the actor during their execution but progress on their own.
 162
 163 Once your asynchronous activity is started, you can test for its
 164 completion using :cpp:func:`s4u::Activity::test() <simgrid::s4u::Activity::test>`.
 165 This function returns ``true`` if the activity completed already.
 166 You can also use :cpp:func:`s4u::Activity::wait() <simgrid::s4u::Activity::wait>`
 167 to block until the completion of the activity. To wait for at most a given amount of time,
 168 use  :cpp:func:`s4u::Activity::wait_for() <simgrid::s4u::Activity::wait_for>`.
 169 Finally, to wait at most until a specified time limit, use
 170 :cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
 171
 172 Every kind of activity can be asynchronous:
 173
 174   - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
 175     :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
 176     :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`.
 177   - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
 178     :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
 179     :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`.
 180   - :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
 181     :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
 182   - In the future, it will become possible to have asynchronous IPC
 183     such as asynchronous mutex lock requests.
 184
 185 The following example shows how to have several concurrent
 186 communications ongoing.  First, you have to declare a vector in which
 187 we will store the ongoing communications. It is also useful to have a
 188 vector of mailboxes.
 189
 190 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
 191    :language: c++
 192    :start-after: init-begin
 193    :end-before: init-end
 194    :dedent: 4
 195
 196 Then, you start all the communications that should occur concurrently with
 197 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
 198 Finally, the actor waits for the completion of all of them at once
 199 with
 200 :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
 201
 202 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
 203    :language: c++
 204    :start-after: put-begin
 205    :end-before: put-end
 206    :dedent: 4
 207
 208
 209 =====================
 210 Activities Life cycle
 211 =====================
 212
 213 Sometimes, you want to change the setting of an activity before it even starts.
 214
 215 .. todo:: write this section
 216
 217 .. _s4u_mailbox:
 218
 219 Mailboxes
 220 *********
 221
 222 Please also refer to the :ref:`API reference for s4u::Mailbox
 223 <API_s4u_Mailbox>`.
 224
 225 ===================
 226 What are Mailboxes?
 227 ===================
 228
 229 |API_s4u_Mailboxes|_ are rendez-vous points for network communications,
 230 similar to URLs on which you could post and retrieve data. Actually,
 231 the mailboxes are not involved in the communication once it starts,
 232 but only to find the contact with which you want to communicate.
 233
 234 They are similar to many common things: The phone number, which allows
 235 the caller to find the receiver. The twitter hashtag, which help
 236 senders and receivers to find each others. In TCP, the pair
 237 ``{host name, host port}`` to which you can connect to find your peer.
 238 In HTTP, URLs through which the clients can connect to the servers.
 239 In ZeroMQ, the queues are used to match senders and receivers.
 240
 241 One big difference with most of these systems is that no actor is the
 242 exclusive owner of a mailbox, neither in sending nor in receiving.
 243 Many actors can send into and/or receive from the same mailbox.  TCP
 244 socket ports for example are shared on the sender side but exclusive
 245 on the receiver side (only one process can receive from a given socket
 246 at a given point of time).
 247
 248 A big difference with TCP sockets or MPI communications is that
 249 communications do not start right away after a
 250 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put>`, but wait
 251 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get>`.
 252 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
 253
 254 A big difference with twitter hashtags is that SimGrid does not
 255 offer easy support to broadcast a given message to many
 256 receivers. So that would be like a twitter tag where each message
 257 is consumed by the first receiver.
 258
 259 A big difference with the ZeroMQ queues is that you cannot filter
 260 on the data you want to get from the mailbox. To model such settings
 261 in SimGrid, you'd have one mailbox per potential topic, and subscribe
 262 to each topic individually with a
 263 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async>` on each mailbox.
 264 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any>`
 265 to get the first message on any of the mailbox you are subscribed onto.
 266
 267 The mailboxes are not located on the network, and you can access
 268 them without any latency. The network delay are only related to the
 269 location of the sender and receiver once the match between them is
 270 done on the mailbox. This is just like the phone number that you
 271 can use locally, and the geographical distance only comes into play
 272 once you start the communication by dialing this number.
 273
 274 =====================
 275 How to use Mailboxes?
 276 =====================
 277
 278 You can retrieve any existing mailbox from its name (which is a
 279 unique string, just like a twitter tag). This results in a
 280 versatile mechanism that can be used to build many different
 281 situations.
 282
 283 To model classical socket communications, use "hostname:port" as
 284 mailbox names, and make sure that only one actor reads into a given
 285 mailbox. This does not make it easy to build a perfectly realistic
 286 model of the TCP sockets, but in most cases, this system is too
 287 cumbersome for your simulations anyway. You probably want something
 288 simpler, that turns our to be easy to build with the mailboxes.
 289
 290 Many SimGrid examples use a sort of yellow page system where the
 291 mailbox names are the name of the service (such as "worker",
 292 "master" or "reducer"). That way, you don't have to know where your
 293 peer is located to contact it. You don't even need its name. Its
 294 function is enough for that. This also gives you some sort of load
 295 balancing for free if more than one actor pulls from the mailbox:
 296 the first actor that can deal with the request will handle it.
 297
 298 =========================================
 299 How are put() and get() requests matched?
 300 =========================================
 301
 302 The matching algorithm simple: first come, first serve. When a new
 303 send arrives, it matches the oldest enqueued receive. If no receive is
 304 currently enqueued, then the incoming send is enqueued. As you can
 305 see, the mailbox cannot contain both send and receive requests: all
 306 enqueued requests must be of the same sort.
 307
 308 .. _s4u_receiving_actor:
 309
 310 ===========================
 311 Declaring a Receiving Actor
 312 ===========================
 313
 314 The last twist is that by default in the simulator, the data starts
 315 to be exchanged only when both the sender and the receiver are
 316 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 317 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
 318 In TCP, since you establish connections beforehand, the data starts to
 319 flow as soon as the sender posts it, even if the receiver did not post
 320 its :cpp:func:`recv() <simgrid::s4u::Mailbox::recv()>` yet.
 321
 322 To model this in SimGrid, you can declare a specific receiver to a
 323 given mailbox (with the function
 324 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
 325 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 326 posted to that mailbox will start as soon as possible, and the data
 327 will already be there on the receiver host when the receiver actor
 328 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
 329
 330 Note that being permanent receivers of a mailbox prevents actors to be
 331 garbage-collected. If your simulation creates many short-lived actors
 332 that marked as permanent receiver, you should call
 333 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
 334 memory gets properly reclaimed. This call should be at the end of the
 335 actor's function, not in an on_exit callback.
 336
 337 .. _s4u_raii:
 338
 339 Memory Management
 340 *****************
 341
 342 For sake of simplicity, we use `RAII
 343 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 344 for many classes in S4U. This is an idiom where resources are automatically
 345 managed through the context. Provided that you never manipulate
 346 objects of type Foo directly but always FooPtr references (which are
 347 defined as `boost::intrusive_ptr
 348 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 349 <Foo>), you will never have to explicitly release the resource that
 350 you use nor to free the memory of unused objects.
 351 Here is a little example:
 352
 353 .. code-block:: cpp
 354
 355    void myFunc()
 356    {
 357      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 358
 359      mutex->lock();   // use the mutex as a simple reference
 360      //  bla bla
 361      mutex->unlock();
 362
 363    } // The mutex gets automatically freed because the only existing reference gets out of scope
 364
 365 Note that Mailboxes, Hosts and Links are not handled thought smart
 366 pointers (yet?). This means that it is currently impossible to destroy a
 367 mailbox or a link. You can still destroy a host (but probably
 368 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 369
 370 .. THE EXAMPLES
 371
 372 .. include:: ../../examples/README.rst
 373
 374 API Reference
 375 *************
 376
 377 .. _API_s4u_simulation_object:
 378
 379 ==================
 380 Simulation objects
 381 ==================
 382
 383 .. _API_s4u_Actor:
 384
 385 ==============
 386 ⁣  class Actor
 387 ==============
 388
 389 .. autodoxyclass:: simgrid::s4u::Actor
 390
 391 .. doxygentypedef:: aid_t
 392
 393 Basic management
 394 ----------------
 395
 396 .. tabs::
 397
 398    .. group-tab:: C++
 399
 400       .. code:: C++
 401
 402          #include <simgrid/s4u/Actor.hpp>
 403
 404       .. doxygentypedef:: ActorPtr
 405
 406    .. group-tab:: Python
 407
 408       .. code:: Python
 409
 410          from simgrid import Actor
 411
 412    .. group-tab:: C
 413
 414       .. code:: C
 415
 416          #include <simgrid/actor.h>
 417
 418       .. doxygentypedef:: sg_actor_t
 419       .. cpp:type:: const s4u_Actor* const_sg_actor_t
 420
 421          Pointer to a constant actor object.
 422
 423       .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
 424       .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
 425
 426 Creating actors
 427 ---------------
 428
 429 .. tabs::
 430
 431    .. group-tab:: C++
 432
 433       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 434       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 435       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 436       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 437
 438       .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 439       .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 440
 441    .. group-tab:: Python
 442
 443       .. automethod:: simgrid.Actor.create
 444
 445    .. group-tab:: C
 446
 447       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
 448       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char *const *argv)
 449
 450       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 451       .. autodoxymethod:: sg_actor_detach()
 452
 453 Retrieving actors
 454 -----------------
 455
 456 .. tabs::
 457
 458    .. group-tab:: C++
 459
 460       .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 461       .. autodoxymethod:: simgrid::s4u::Actor::self()
 462
 463    .. group-tab:: Python
 464
 465       .. automethod:: simgrid.Actor.by_pid
 466       .. automethod:: simgrid.Actor.self
 467
 468    .. group-tab:: C
 469
 470       .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
 471       .. autodoxymethod:: sg_actor_self()
 472
 473 Querying info
 474 -------------
 475
 476 .. tabs::
 477
 478    .. group-tab:: C++
 479
 480       .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 481       .. autodoxymethod:: simgrid::s4u::Actor::get_name
 482       .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 483       .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 484       .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 485       .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 486       .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 487
 488       .. autodoxymethod:: simgrid::s4u::Actor::get_host
 489       .. autodoxymethod:: simgrid::s4u::Actor::set_host
 490
 491       .. autodoxymethod:: simgrid::s4u::Actor::get_refcount
 492       .. autodoxymethod:: simgrid::s4u::Actor::get_impl
 493
 494    .. group-tab:: Python
 495
 496       .. autoattribute:: simgrid.Actor.name
 497       .. autoattribute:: simgrid.Actor.host
 498       .. autoattribute:: simgrid.Actor.pid
 499       .. autoattribute:: simgrid.Actor.ppid
 500
 501    .. group-tab:: C
 502
 503       .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
 504       .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
 505       .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
 506       .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
 507       .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 508
 509       .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
 510       .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 511
 512       .. autodoxymethod:: sg_actor_get_data(const_sg_actor_t actor)
 513       .. autodoxymethod:: sg_actor_set_data(sg_actor_t actor, void *userdata)
 514
 515 Suspending and resuming actors
 516 ------------------------------
 517
 518 .. tabs::
 519
 520    .. group-tab:: C++
 521
 522       .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 523       .. autodoxymethod:: simgrid::s4u::Actor::resume()
 524       .. autodoxymethod:: simgrid::s4u::Actor::is_suspended
 525
 526    .. group-tab:: Python
 527
 528       .. automethod:: simgrid.Actor.resume
 529       .. automethod:: simgrid.Actor.suspend
 530       .. automethod:: simgrid.Actor.is_suspended
 531
 532    .. group-tab:: C
 533
 534       .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
 535       .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
 536       .. autodoxymethod:: sg_actor_is_suspended(const_sg_actor_t actor)
 537
 538 Specifying when actors should terminate
 539 ---------------------------------------
 540
 541 .. tabs::
 542
 543    .. group-tab:: C++
 544
 545       .. autodoxymethod:: simgrid::s4u::Actor::kill()
 546       .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 547       .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 548       .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time
 549
 550       .. autodoxymethod:: simgrid::s4u::Actor::restart()
 551       .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 552       .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 553
 554    .. group-tab:: Python
 555
 556       .. automethod:: simgrid.Actor.kill
 557       .. automethod:: simgrid.Actor.kill_all
 558
 559       .. automethod:: simgrid.Actor.daemonize
 560       .. automethod:: simgrid.Actor.is_daemon
 561
 562    .. group-tab:: C
 563
 564       .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
 565       .. autodoxymethod:: sg_actor_kill_all()
 566       .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 567
 568       .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
 569       .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
 570       .. autodoxymethod:: sg_actor_is_daemon
 571
 572 .. _API_s4u_Actor_end:
 573
 574 Reacting to the end of actors
 575 -----------------------------
 576
 577 .. tabs::
 578
 579    .. group-tab:: C++
 580
 581       .. autodoxymethod:: simgrid::s4u::Actor::on_exit
 582       .. autodoxymethod:: simgrid::s4u::Actor::join() const
 583       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout) const
 584       .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 585
 586    .. group-tab:: Python
 587
 588       .. automethod:: simgrid.Actor.join
 589
 590    .. group-tab:: C
 591
 592       .. autodoxymethod:: sg_actor_join(const_sg_actor_t actor, double timeout)
 593       .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 594
 595 Signals
 596 -------
 597
 598 .. tabs::
 599
 600    .. group-tab:: C++
 601
 602       .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 603       .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 604       .. cpp:var:: xbt::signal<void(const simgrid::s4u::Actor&, const simgrid::s4u::Host & previous_location)> Actor::on_host_change
 605
 606          Signal fired when an actor is migrated from one host to another.
 607
 608       .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 609       .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 610       .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 611       .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 612       .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 613
 614 .. _API_s4u_this_actor:
 615
 616 ====================
 617 ⁣  The current actor
 618 ====================
 619
 620 These functions can be used in your user code to interact with the actor
 621 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 622 Using these functions can greatly improve the code readability.
 623
 624 Querying info
 625 -------------
 626
 627 .. tabs::
 628
 629    .. group-tab:: C++
 630
 631       .. autodoxymethod:: simgrid::s4u::this_actor::get_cname()
 632       .. autodoxymethod:: simgrid::s4u::this_actor::get_name()
 633       .. autodoxymethod:: simgrid::s4u::this_actor::get_pid()
 634       .. autodoxymethod:: simgrid::s4u::this_actor::get_ppid()
 635       .. autodoxymethod:: simgrid::s4u::this_actor::is_maestro()
 636
 637       .. autodoxymethod:: simgrid::s4u::this_actor::get_host()
 638       .. autodoxymethod:: simgrid::s4u::this_actor::set_host(simgrid::s4u::Host *new_host)
 639
 640    .. group-tab:: Python
 641
 642       .. autofunction:: simgrid.this_actor.get_host
 643       .. autofunction:: simgrid.this_actor.set_host
 644
 645    .. group-tab:: C
 646
 647       .. autodoxymethod:: sg_actor_self_get_data()
 648       .. autodoxymethod:: sg_actor_self_set_data(void *data)
 649       .. autodoxymethod:: sg_actor_self_get_name()
 650       .. autodoxymethod:: sg_actor_self_get_pid()
 651       .. autodoxymethod:: sg_actor_self_get_ppid()
 652       .. autodoxymethod:: sg_host_self()
 653       .. autodoxymethod:: sg_host_self_get_name()
 654
 655 Suspending and resuming
 656 -----------------------
 657
 658 .. tabs::
 659
 660    .. group-tab:: C++
 661
 662       .. autodoxymethod:: simgrid::s4u::this_actor::suspend()
 663       .. autodoxymethod:: simgrid::s4u::this_actor::yield()
 664
 665    .. group-tab:: Python
 666
 667       .. autofunction:: simgrid.this_actor.suspend
 668       .. autofunction:: simgrid.this_actor.yield_
 669
 670 Logging messages
 671 ----------------
 672
 673 .. tabs::
 674
 675    .. group-tab:: Python
 676
 677        .. autofunction:: simgrid.this_actor.info
 678        .. autofunction:: simgrid.this_actor.error
 679
 680 Sleeping
 681 --------
 682
 683 .. tabs::
 684
 685    .. group-tab:: C++
 686
 687       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(double duration)
 688       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
 689       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
 690       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
 691
 692    .. group-tab:: Python
 693
 694       .. autofunction:: simgrid.this_actor.sleep_for
 695       .. autofunction:: simgrid.this_actor.sleep_until
 696
 697    .. group-tab:: C
 698
 699       .. autodoxymethod:: sg_actor_sleep_for(double duration)
 700
 701 Simulating executions
 702 ---------------------
 703
 704 Simulate the execution of some code on this actor. You can either simulate
 705 parallel or sequential code, and you can either block upon the termination of
 706 the execution, or start an asynchronous activity.
 707
 708 .. tabs::
 709
 710    .. group-tab:: C++
 711
 712       .. autodoxymethod:: simgrid::s4u::this_actor::exec_async
 713       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 714       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
 715       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
 716       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
 717       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 718       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
 719
 720    .. group-tab:: Python
 721
 722       .. autofunction:: simgrid.this_actor.exec_init
 723       .. autofunction:: simgrid.this_actor.execute
 724
 725    .. group-tab:: C
 726
 727       .. autodoxymethod:: sg_actor_self_execute(double flops)
 728
 729 Exiting
 730 -------
 731
 732 .. tabs::
 733
 734    .. group-tab:: C++
 735
 736       .. autodoxymethod:: simgrid::s4u::this_actor::exit()
 737       .. autodoxymethod:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 738
 739    .. group-tab:: Python
 740
 741       .. autofunction:: simgrid.this_actor.exit
 742       .. autofunction:: simgrid.this_actor.on_exit
 743
 744 .. _API_s4u_Engine:
 745
 746 ====================
 747 ⁣  Simulation Engine
 748 ====================
 749
 750 .. autodoxyclass:: simgrid::s4u::Engine
 751
 752 Initialization
 753 --------------
 754
 755 .. tabs::
 756
 757    .. group-tab:: C++
 758
 759       .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 760       .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
 761       .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
 762       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
 763       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
 764       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
 765       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
 766       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
 767
 768       .. autodoxymethod:: simgrid::s4u::Engine::load_deployment
 769       .. autodoxymethod:: simgrid::s4u::Engine::load_platform
 770       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
 771       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 772       .. autodoxymethod:: simgrid::s4u::Engine::register_default(void(*code)(int, char **))
 773       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
 774       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(int, char **))
 775
 776    .. group-tab:: Python
 777
 778        .. automethod:: simgrid.Engine.load_deployment
 779        .. automethod:: simgrid.Engine.load_platform
 780        .. automethod:: simgrid.Engine.register_actor
 781
 782    .. group-tab:: C
 783
 784       .. autodoxymethod:: simgrid_init
 785
 786       .. autodoxymethod:: simgrid_load_deployment
 787       .. autodoxymethod:: simgrid_load_platform
 788       .. autodoxymethod:: simgrid_register_default
 789       .. autodoxymethod:: simgrid_register_function
 790
 791 Run the simulation
 792 ------------------
 793
 794 .. tabs::
 795
 796    .. group-tab:: C++
 797
 798       .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
 799       .. autodoxymethod:: simgrid::s4u::Engine::run
 800
 801    .. group-tab:: Python
 802
 803       .. automethod:: simgrid.Engine.get_clock
 804       .. automethod:: simgrid.Engine.run
 805
 806    .. group-tab:: C
 807
 808       .. autodoxymethod:: simgrid_get_clock
 809       .. autodoxymethod:: simgrid_run
 810
 811 Retrieving actors
 812 -----------------
 813
 814 .. tabs::
 815
 816    .. group-tab:: C++
 817
 818       .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count
 819       .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors
 820       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors
 821
 822    .. group-tab:: C
 823
 824       .. autodoxymethod:: simgrid_get_actor_count()
 825
 826 Retrieving hosts
 827 ----------------
 828
 829 .. tabs::
 830
 831    .. group-tab:: C++
 832
 833       .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts
 834       .. autodoxymethod:: simgrid::s4u::Engine::get_host_count
 835       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts
 836       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name
 837       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null
 838
 839    .. group-tab:: Python
 840
 841       .. automethod:: simgrid.Engine.get_all_hosts
 842
 843    .. group-tab:: C
 844
 845       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 846
 847 Retrieving links
 848 ----------------
 849
 850 .. tabs::
 851
 852    .. group-tab:: C++
 853
 854       .. autodoxymethod:: simgrid::s4u::Engine::get_all_links
 855       .. autodoxymethod:: simgrid::s4u::Engine::get_link_count
 856       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
 857       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name
 858       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null
 859
 860 Interacting with the routing
 861 ----------------------------
 862
 863 .. tabs::
 864
 865    .. group-tab:: C++
 866
 867       .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints
 868       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones
 869       .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
 870       .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root
 871       .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null
 872       .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null
 873       .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 874
 875 Signals
 876 -------
 877
 878 .. tabs::
 879
 880    .. group-tab:: C++
 881
 882       .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
 883       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
 884       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
 885       .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
 886       .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
 887
 888 .. _API_s4u_Mailbox:
 889
 890 ================
 891 ⁣  class Mailbox
 892 ================
 893
 894 .. autodoxyclass:: simgrid::s4u::Mailbox
 895
 896 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 897
 898 Basic management
 899 ----------------
 900
 901 .. tabs::
 902
 903    .. group-tab:: C++
 904
 905       .. code-block:: C++
 906
 907          #include <simgrid/s4u/Mailbox.hpp>
 908
 909       Note that there is no MailboxPtr type, and that you cannot use the RAII
 910       idiom on mailboxes because they are internal objects to the simulation
 911       engine. Once created, there is no way to destroy a mailbox before the end
 912       of the simulation.
 913
 914       .. autodoxymethod:: simgrid::s4u::Mailbox::by_name(const std::string &name)
 915
 916    .. group-tab:: Python
 917
 918       .. automethod:: simgrid.Mailbox.by_name
 919
 920 Querying info
 921 -------------
 922
 923 .. tabs::
 924
 925    .. group-tab:: C++
 926
 927       .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname
 928       .. autodoxymethod:: simgrid::s4u::Mailbox::get_name
 929
 930    .. group-tab:: Python
 931
 932       .. autoattribute:: simgrid.Mailbox.name
 933
 934 Sending data
 935 ------------
 936
 937 .. tabs::
 938
 939    .. group-tab:: C++
 940
 941       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
 942       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
 943       .. autodoxymethod:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
 944       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init()
 945       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
 946
 947    .. group-tab:: Python
 948
 949       .. automethod:: simgrid.Mailbox.put
 950       .. automethod:: simgrid.Mailbox.put_async
 951
 952
 953 Receiving data
 954 --------------
 955
 956 .. tabs::
 957
 958    .. group-tab:: C++
 959
 960       .. autodoxymethod:: simgrid::s4u::Mailbox::empty
 961       .. autodoxymethod:: simgrid::s4u::Mailbox::front
 962       .. autodoxymethod:: simgrid::s4u::Mailbox::get()
 963       .. autodoxymethod:: simgrid::s4u::Mailbox::get(double timeout)
 964       .. autodoxymethod:: simgrid::s4u::Mailbox::get_async(void **data)
 965       .. autodoxymethod:: simgrid::s4u::Mailbox::get_init()
 966       .. autodoxymethod:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
 967       .. autodoxymethod:: simgrid::s4u::Mailbox::listen
 968       .. autodoxymethod:: simgrid::s4u::Mailbox::ready
 969
 970    .. group-tab:: Python
 971
 972        .. automethod:: simgrid.Mailbox.get
 973
 974    .. group-tab:: C
 975
 976       .. autodoxymethod:: sg_mailbox_listen(const char *alias)
 977
 978 Receiving actor
 979 ---------------
 980
 981 See :ref:`s4u_receiving_actor`.
 982
 983 .. tabs::
 984
 985    .. group-tab:: C++
 986
 987       .. autodoxymethod:: simgrid::s4u::Mailbox::get_receiver
 988       .. autodoxymethod:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
 989
 990    .. group-tab:: C
 991
 992       .. autodoxymethod:: sg_mailbox_set_receiver(const char *alias)
 993
 994 .. _API_s4u_Resource:
 995
 996 =========
 997 Resources
 998 =========
 999
1000 .. _API_s4u_Disk:
1001
1002 =============
1003 ⁣  class Disk
1004 =============
1005
1006 .. autodoxyclass:: simgrid::s4u::Disk
1007
1008 Basic management
1009 ----------------
1010
1011 .. tabs::
1012
1013    .. group-tab:: C++
1014
1015       .. code-block:: C++
1016
1017          #include <simgrid/s4u/Disk.hpp>
1018
1019       Note that there is no DiskPtr type, and that you cannot use the RAII
1020       idiom on disks because SimGrid does not allow (yet) to create nor
1021       destroy resources once the simulation is started.
1022
1023
1024 Querying info
1025 -------------
1026
1027 .. tabs::
1028
1029    .. group-tab:: C++
1030
1031       .. autodoxymethod:: simgrid::s4u::Disk::get_cname() const
1032       .. autodoxymethod:: simgrid::s4u::Disk::get_host() const
1033       .. autodoxymethod:: simgrid::s4u::Disk::get_name() const
1034       .. autodoxymethod:: simgrid::s4u::Disk::get_properties() const
1035       .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key) const
1036       .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth() const
1037       .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth() const
1038       .. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1039
1040 I/O operations
1041 --------------
1042
1043 .. tabs::
1044
1045    .. group-tab:: C++
1046
1047       .. autodoxymethod:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type)
1048       .. autodoxymethod:: simgrid::s4u::Disk::read(sg_size_t size)
1049       .. autodoxymethod:: simgrid::s4u::Disk::read_async(sg_size_t size)
1050       .. autodoxymethod:: simgrid::s4u::Disk::write(sg_size_t size)
1051       .. autodoxymethod:: simgrid::s4u::Disk::write_async(sg_size_t size)
1052
1053 Signals
1054 -------
1055
1056 .. tabs::
1057
1058    .. group-tab:: C++
1059
1060       .. autodoxyvar:: simgrid::s4u::Disk::on_creation
1061       .. autodoxyvar:: simgrid::s4u::Disk::on_destruction
1062       .. autodoxyvar:: simgrid::s4u::Disk::on_state_change
1063
1064
1065 .. _API_s4u_Host:
1066
1067 =============
1068 ⁣  class Host
1069 =============
1070
1071 .. autodoxyclass:: simgrid::s4u::Host
1072
1073 Basic management
1074 ----------------
1075
1076 .. tabs::
1077
1078    .. group-tab:: C++
1079
1080       .. code-block:: C++
1081
1082          #include <simgrid/s4u/Host.hpp>
1083
1084       Note that there is no HostPtr type, and that you cannot use the RAII
1085       idiom on hosts because SimGrid does not allow (yet) to create nor
1086       destroy resources once the simulation is started.
1087
1088       .. autodoxymethod:: simgrid::s4u::Host::destroy()
1089
1090    .. group-tab:: Python
1091
1092       .. code:: Python
1093
1094          from simgrid import Host
1095
1096    .. group-tab:: C
1097
1098       .. code:: C
1099
1100          #include <simgrid/host.h>
1101
1102       .. doxygentypedef:: sg_host_t
1103       .. cpp:type:: const s4u_Host* const_sg_host_t
1104
1105          Pointer to a constant host object.
1106
1107 Retrieving hosts
1108 ----------------
1109
1110 .. tabs::
1111
1112    .. group-tab:: C++
1113
1114       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1115
1116       .. autodoxymethod:: simgrid::s4u::Host::by_name(const std::string &name)
1117       .. autodoxymethod:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1118       .. autodoxymethod:: simgrid::s4u::Host::current()
1119
1120    .. group-tab:: Python
1121
1122       See also :py:func:`simgrid.Engine.get_all_hosts`.
1123
1124       .. automethod:: simgrid.Host.by_name
1125       .. automethod:: simgrid.Host.current
1126
1127    .. group-tab:: C
1128
1129       .. autodoxymethod:: sg_host_by_name(const char *name)
1130       .. autodoxymethod:: sg_host_count()
1131       .. autodoxymethod:: sg_host_list()
1132       .. autodoxymethod:: sg_hosts_as_dynar()
1133
1134 Querying info
1135 -------------
1136
1137 .. tabs::
1138
1139    .. group-tab:: C++
1140
1141       .. autodoxymethod:: simgrid::s4u::Host::get_cname() const
1142       .. autodoxymethod:: simgrid::s4u::Host::get_core_count() const
1143       .. autodoxymethod:: simgrid::s4u::Host::get_name() const
1144       .. autodoxymethod:: simgrid::s4u::Host::get_available_speed() const
1145       .. autodoxymethod:: simgrid::s4u::Host::get_load() const
1146       .. autodoxymethod:: simgrid::s4u::Host::get_speed() const
1147
1148    .. group-tab:: Python
1149
1150       .. autoattribute:: simgrid.Host.name
1151       .. autoattribute:: simgrid.Host.load
1152       .. autoattribute:: simgrid.Host.pstate
1153       .. autoattribute:: simgrid.Host.speed
1154
1155    .. group-tab:: C
1156
1157       .. autodoxymethod:: sg_host_core_count(const_sg_host_t host)
1158       .. autodoxymethod:: sg_host_dump(const_sg_host_t ws)
1159       .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
1160       .. autodoxymethod:: sg_host_get_load(const_sg_host_t host)
1161       .. autodoxymethod:: sg_host_get_speed(const_sg_host_t host)
1162
1163 User data and properties
1164 ------------------------
1165
1166 .. tabs::
1167
1168    .. group-tab:: C++
1169
1170       .. autodoxymethod:: simgrid::s4u::Host::get_properties() const
1171       .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key) const
1172       .. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::map< std::string, std::string > &properties)
1173       .. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1174
1175    .. group-tab:: C
1176
1177       .. autodoxymethod:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1178       .. autodoxymethod:: sg_host_get_properties(const_sg_host_t host)
1179       .. autodoxymethod:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1180       .. autodoxymethod:: sg_host_extension_create(void(*deleter)(void *))
1181       .. autodoxymethod:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1182
1183 Retrieving components
1184 ---------------------
1185
1186 .. tabs::
1187
1188    .. group-tab:: C++
1189
1190       .. autodoxymethod:: simgrid::s4u::Host::add_disk(const Disk* disk)
1191       .. autodoxymethod:: simgrid::s4u::Host::get_actor_count() const
1192       .. autodoxymethod:: simgrid::s4u::Host::get_all_actors() const
1193       .. autodoxymethod:: simgrid::s4u::Host::get_disks() const
1194       .. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1195
1196    .. group-tab:: C
1197
1198       .. autodoxymethod:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1199
1200 On/Off
1201 ------
1202
1203 .. tabs::
1204
1205    .. group-tab:: C++
1206
1207       .. autodoxymethod:: simgrid::s4u::Host::is_on() const
1208       .. autodoxymethod:: simgrid::s4u::Host::turn_off()
1209       .. autodoxymethod:: simgrid::s4u::Host::turn_on()
1210
1211    .. group-tab:: C
1212
1213       .. autodoxymethod:: sg_host_is_on(const_sg_host_t host)
1214       .. autodoxymethod:: sg_host_turn_off(sg_host_t host)
1215       .. autodoxymethod:: sg_host_turn_on(sg_host_t host)
1216
1217 DVFS
1218 ----
1219
1220 .. tabs::
1221
1222    .. group-tab:: C++
1223
1224       .. autodoxymethod:: simgrid::s4u::Host::get_pstate() const
1225       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count() const
1226       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
1227       .. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
1228       .. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1229       .. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1230
1231    .. group-tab:: Python
1232
1233       .. automethod:: simgrid.Host.get_pstate_count
1234       .. automethod:: simgrid.Host.get_pstate_speed
1235
1236    .. group-tab:: C
1237
1238       .. autodoxymethod:: sg_host_get_available_speed(const_sg_host_t host)
1239       .. autodoxymethod:: sg_host_get_nb_pstates(const_sg_host_t host)
1240       .. autodoxymethod:: sg_host_get_pstate(const_sg_host_t host)
1241       .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1242       .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
1243
1244 Execution
1245 ---------
1246
1247 .. tabs::
1248
1249    .. group-tab:: C++
1250
1251       .. autodoxymethod:: simgrid::s4u::Host::exec_async
1252       .. autodoxymethod:: simgrid::s4u::Host::execute(double flops) const
1253       .. autodoxymethod:: simgrid::s4u::Host::execute(double flops, double priority) const
1254
1255 Platform and routing
1256 --------------------
1257
1258 .. tabs::
1259
1260    .. group-tab:: C++
1261
1262       .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
1263       .. autodoxymethod:: simgrid::s4u::Host::get_netpoint() const
1264       .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1265       .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
1266       .. autodoxymethod:: simgrid::s4u::Host::sendto(Host *dest, double byte_amount)
1267       .. autodoxymethod:: simgrid::s4u::Host::sendto_async(Host *dest, double byte_amount)
1268
1269    .. group-tab:: C
1270
1271       .. autodoxymethod:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1272       .. autodoxymethod:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1273       .. autodoxymethod:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1274       .. autodoxymethod:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1275
1276 Signals
1277 -------
1278
1279 .. tabs::
1280
1281    .. group-tab:: C++
1282
1283       .. autodoxyvar:: simgrid::s4u::Host::on_creation
1284       .. autodoxyvar:: simgrid::s4u::Host::on_destruction
1285       .. autodoxyvar:: simgrid::s4u::Host::on_speed_change
1286       .. autodoxyvar:: simgrid::s4u::Host::on_state_change
1287
1288 .. _API_s4u_Link:
1289
1290 =============
1291 ⁣  class Link
1292 =============
1293
1294 .. autodoxyclass:: simgrid::s4u::Link
1295
1296 Basic management
1297 ----------------
1298
1299 .. tabs::
1300
1301    .. group-tab:: C++
1302
1303       .. code-block:: C++
1304
1305          #include <simgrid/s4u/Link.hpp>
1306
1307       Note that there is no LinkPtr type, and that you cannot use the RAII
1308       idiom on hosts because SimGrid does not allow (yet) to create nor
1309       destroy resources once the simulation is started.
1310
1311    .. group-tab:: Python
1312
1313       .. code:: Python
1314
1315          from simgrid import Link
1316
1317    .. group-tab:: C
1318
1319       .. code:: C
1320
1321          #include <simgrid/link.h>
1322
1323       .. doxygentypedef:: sg_link_t
1324       .. cpp:type:: const s4u_Link* const_sg_link_t
1325
1326          Pointer to a constant link object.
1327
1328 Retrieving links
1329 ----------------
1330
1331 .. tabs::
1332
1333    .. group-tab:: C++
1334
1335       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1336
1337       .. autodoxymethod:: simgrid::s4u::Link::by_name(const std::string &name)
1338       .. autodoxymethod:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1339
1340    .. group-tab:: C
1341
1342       .. autodoxymethod:: sg_link_by_name(const char *name)
1343       .. autodoxymethod:: sg_link_count()
1344       .. autodoxymethod:: sg_link_list()
1345
1346 Querying info
1347 --------------
1348
1349 .. tabs::
1350
1351    .. group-tab:: C++
1352
1353       .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth() const
1354       .. autodoxymethod:: simgrid::s4u::Link::get_cname() const
1355       .. autodoxymethod:: simgrid::s4u::Link::get_latency() const
1356       .. autodoxymethod:: simgrid::s4u::Link::get_name() const
1357       .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy() const
1358       .. autodoxymethod:: simgrid::s4u::Link::get_usage() const
1359       .. autodoxymethod:: simgrid::s4u::Link::is_used() const
1360
1361    .. group-tab:: C
1362
1363       .. autodoxymethod:: sg_link_get_bandwidth(const_sg_link_t link)
1364       .. autodoxymethod:: sg_link_get_latency(const_sg_link_t link)
1365       .. autodoxymethod:: sg_link_get_name(const_sg_link_t link)
1366       .. autodoxymethod:: sg_link_is_shared(const_sg_link_t link)
1367
1368 Modifying characteristics
1369 -------------------------
1370
1371 .. tabs::
1372
1373    .. group-tab:: C++
1374
1375       .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth(double value)
1376       .. autodoxymethod:: simgrid::s4u::Link::set_latency(double value)
1377
1378    .. group-tab:: C
1379
1380       .. autodoxymethod:: sg_link_set_bandwidth(const_sg_link_t link, double value)
1381       .. autodoxymethod:: sg_link_set_latency(const_sg_link_t link, double value)
1382
1383 User data and properties
1384 ------------------------
1385
1386 .. tabs::
1387
1388    .. group-tab:: C++
1389
1390       .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key) const
1391       .. autodoxymethod:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1392
1393    .. group-tab:: C
1394
1395       .. autodoxymethod:: sg_link_get_data(const_sg_link_t link)
1396       .. autodoxymethod:: sg_link_set_data(sg_link_t link, void *data)
1397
1398 On/Off
1399 ------
1400
1401 .. tabs::
1402
1403    .. group-tab:: C++
1404
1405       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1406
1407       .. autodoxymethod:: simgrid::s4u::Link::is_on() const
1408       .. autodoxymethod:: simgrid::s4u::Link::turn_off()
1409       .. autodoxymethod:: simgrid::s4u::Link::turn_on()
1410
1411 Dynamic profiles
1412 ----------------
1413
1414 See :ref:`howto_churn` for more details.
1415
1416 .. tabs::
1417
1418    .. group-tab:: C++
1419
1420       .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1421       .. autodoxymethod:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1422       .. autodoxymethod:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1423
1424 WIFI links
1425 ----------
1426
1427 .. tabs::
1428
1429    .. group-tab:: C++
1430
1431       .. autodoxymethod:: simgrid::s4u::Link::set_host_wifi_rate
1432
1433 Signals
1434 -------
1435
1436 .. tabs::
1437
1438    .. group-tab:: C++
1439
1440       .. autodoxyvar:: simgrid::s4u::Link::on_bandwidth_change
1441       .. cpp:var:: xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> Link::on_communicate
1442       .. autodoxyvar:: simgrid::s4u::Link::on_communication_state_change
1443       .. autodoxyvar:: simgrid::s4u::Link::on_creation
1444       .. autodoxyvar:: simgrid::s4u::Link::on_destruction
1445       .. autodoxyvar:: simgrid::s4u::Link::on_state_change
1446
1447 .. _API_s4u_NetZone:
1448
1449 ================
1450 ⁣  class NetZone
1451 ================
1452
1453 .. autodoxyclass:: simgrid::s4u::NetZone
1454
1455 Basic management
1456 ----------------
1457
1458 .. tabs::
1459
1460    .. group-tab:: C++
1461
1462       .. code-block:: C++
1463
1464          #include <simgrid/s4u/NetZone.hpp>
1465
1466       Note that there is no NetZonePtr type, and that you cannot use the RAII
1467       idiom on network zones because SimGrid does not allow (yet) to create nor
1468       destroy resources once the simulation is started.
1469
1470    .. group-tab:: C
1471
1472       .. code:: C
1473
1474          #include <simgrid/zone.h>
1475
1476       .. doxygentypedef:: sg_netzone_t
1477       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1478
1479          Pointer to a constant network zone object.
1480
1481 Retrieving zones
1482 ----------------
1483
1484 .. tabs::
1485
1486    .. group-tab:: C++
1487
1488       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1489       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1490       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1491
1492    .. group-tab:: C
1493
1494       .. autodoxymethod:: sg_zone_get_by_name(const char *name)
1495       .. autodoxymethod:: sg_zone_get_root()
1496
1497 Querying info
1498 --------------
1499
1500 .. tabs::
1501
1502    .. group-tab:: C++
1503
1504       .. autodoxymethod:: simgrid::s4u::NetZone::get_cname() const
1505       .. autodoxymethod:: simgrid::s4u::NetZone::get_name() const
1506
1507    .. group-tab:: C
1508
1509       .. autodoxymethod:: sg_zone_get_name(const_sg_netzone_t zone)
1510
1511 User data and properties
1512 ------------------------
1513
1514 .. tabs::
1515
1516    .. group-tab:: C++
1517
1518       .. autodoxymethod:: simgrid::s4u::NetZone::get_properties() const
1519       .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1520       .. autodoxymethod:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1521
1522    .. group-tab:: C
1523
1524       .. autodoxymethod:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1525       .. autodoxymethod:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1526
1527 Retrieving components
1528 ---------------------
1529
1530 .. tabs::
1531
1532    .. group-tab:: C++
1533
1534       .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts() const
1535       .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count() const
1536
1537    .. group-tab:: C
1538
1539       .. autodoxymethod:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1540
1541 Routing data
1542 ------------
1543
1544 .. tabs::
1545
1546    .. group-tab:: C++
1547
1548       .. autodoxymethod:: simgrid::s4u::NetZone::add_bypass_route
1549       .. autodoxymethod:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1550       .. autodoxymethod:: simgrid::s4u::NetZone::add_route
1551       .. autodoxymethod:: simgrid::s4u::NetZone::get_children() const
1552       .. autodoxymethod:: simgrid::s4u::NetZone::get_father()
1553
1554    .. group-tab:: C
1555
1556       .. autodoxymethod:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1557
1558 Signals
1559 -------
1560
1561 .. tabs::
1562
1563   .. group-tab:: C++
1564
1565      .. autodoxyvar:: simgrid::s4u::NetZone::on_creation
1566      .. autodoxyvar:: simgrid::s4u::NetZone::on_route_creation
1567      .. autodoxyvar:: simgrid::s4u::NetZone::on_seal
1568
1569 .. _API_s4u_VirtualMachine:
1570
1571 =======================
1572 ⁣  class VirtualMachine
1573 =======================
1574
1575
1576 .. autodoxyclass:: simgrid::s4u::VirtualMachine
1577
1578 Basic management
1579 ----------------
1580 .. tabs::
1581
1582    .. group-tab:: C++
1583
1584       .. code-block:: C++
1585
1586          #include <simgrid/s4u/VirtualMachine.hpp>
1587
1588       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1589       idiom on virtual machines. There is no good reason for that and should change in the future.
1590
1591    .. group-tab:: C
1592
1593       .. code:: C
1594
1595          #include <simgrid/vm.h>
1596
1597       .. doxygentypedef:: sg_vm_t
1598       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1599
1600          Pointer to a constant virtual machine object.
1601
1602 Creating VMs
1603 ------------
1604
1605 .. tabs::
1606
1607    .. group-tab:: C++
1608
1609       .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1610       .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1611       .. autodoxymethod:: simgrid::s4u::VirtualMachine::destroy
1612
1613    .. group-tab:: C
1614
1615       .. autodoxymethod:: sg_vm_create_core
1616       .. autodoxymethod:: sg_vm_create_multicore
1617       .. autodoxymethod:: sg_vm_destroy
1618
1619 Querying info
1620 --------------
1621
1622 .. tabs::
1623
1624    .. group-tab:: C++
1625
1626       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_pm() const
1627       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_ramsize() const
1628       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_state() const
1629
1630       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1631       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1632       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1633
1634    .. group-tab:: C
1635
1636       .. autodoxymethod:: sg_vm_get_ramsize(const_sg_vm_t vm)
1637       .. autodoxymethod:: sg_vm_set_bound(sg_vm_t vm, double bound)
1638       .. autodoxymethod:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1639
1640       .. autodoxymethod:: sg_vm_get_name
1641       .. autodoxymethod:: sg_vm_get_pm
1642       .. autodoxymethod:: sg_vm_is_created
1643       .. autodoxymethod:: sg_vm_is_running
1644       .. autodoxymethod:: sg_vm_is_suspended
1645
1646 Life cycle
1647 ----------
1648
1649 .. tabs::
1650
1651    .. group-tab:: C++
1652
1653       .. autodoxymethod:: simgrid::s4u::VirtualMachine::resume()
1654       .. autodoxymethod:: simgrid::s4u::VirtualMachine::shutdown()
1655       .. autodoxymethod:: simgrid::s4u::VirtualMachine::start()
1656       .. autodoxymethod:: simgrid::s4u::VirtualMachine::suspend()
1657
1658    .. group-tab:: C
1659
1660       .. autodoxymethod:: sg_vm_start
1661       .. autodoxymethod:: sg_vm_suspend
1662       .. autodoxymethod:: sg_vm_resume
1663       .. autodoxymethod:: sg_vm_shutdown
1664
1665 Signals
1666 -------
1667
1668 .. tabs::
1669
1670    .. group-tab:: C++
1671
1672       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_end
1673       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_start
1674       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_resume
1675       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_shutdown
1676       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_start
1677       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_started
1678       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_suspend
1679
1680 .. _API_s4u_Activity:
1681
1682 ==============
1683 class Activity
1684 ==============
1685
1686 .. autodoxyclass:: simgrid::s4u::Activity
1687
1688    **Known subclasses:**
1689    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1690    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1691    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1692    See also the :ref:`section on activities <s4u_Activities>` above.
1693
1694 Basic management
1695 ----------------
1696
1697 .. tabs::
1698
1699    .. group-tab:: C++
1700
1701       .. code-block:: C++
1702
1703          #include <simgrid/s4u/Activity.hpp>
1704
1705       .. doxygentypedef:: ActivityPtr
1706
1707 Querying info
1708 -------------
1709
1710 .. tabs::
1711
1712    .. group-tab:: C++
1713
1714       .. autodoxymethod:: simgrid::s4u::Activity::get_cname
1715       .. autodoxymethod:: simgrid::s4u::Activity::get_name
1716       .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() const
1717       .. autodoxymethod:: simgrid::s4u::Activity::get_state() const
1718       .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
1719       .. autodoxymethod:: simgrid::s4u::Activity::set_state(Activity::State state)
1720
1721
1722 Activities life cycle
1723 ---------------------
1724
1725 .. tabs::
1726
1727    .. group-tab:: C++
1728
1729       .. autodoxymethod:: simgrid::s4u::Activity::start
1730       .. autodoxymethod:: simgrid::s4u::Activity::cancel
1731       .. autodoxymethod:: simgrid::s4u::Activity::test
1732       .. autodoxymethod:: simgrid::s4u::Activity::wait
1733       .. autodoxymethod:: simgrid::s4u::Activity::wait_for
1734       .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
1735       .. autodoxymethod:: simgrid::s4u::Activity::vetoable_start()
1736
1737 Suspending and resuming an activity
1738 -----------------------------------
1739
1740 .. tabs::
1741
1742    .. group-tab:: C++
1743
1744       .. autodoxymethod:: simgrid::s4u::Activity::suspend
1745       .. autodoxymethod:: simgrid::s4u::Activity::resume
1746       .. autodoxymethod:: simgrid::s4u::Activity::is_suspended
1747
1748 .. _API_s4u_Comm:
1749
1750 =============
1751 ⁣  class Comm
1752 =============
1753
1754 .. autodoxyclass:: simgrid::s4u::Comm
1755
1756 Basic management
1757 ----------------
1758
1759 .. tabs::
1760
1761    .. group-tab:: C++
1762
1763       .. code-block:: C++
1764
1765          #include <simgrid/s4u/Comm.hpp>
1766
1767       .. doxygentypedef:: CommPtr
1768
1769    .. group-tab:: Python
1770
1771       .. code:: Python
1772
1773          from simgrid import Comm
1774
1775 Querying info
1776 -------------
1777
1778 .. tabs::
1779
1780    .. group-tab:: C++
1781
1782       .. autodoxymethod:: simgrid::s4u::Comm::get_dst_data_size() const
1783       .. autodoxymethod:: simgrid::s4u::Comm::get_mailbox() const
1784       .. autodoxymethod:: simgrid::s4u::Comm::get_sender() const
1785       .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff)
1786       .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
1787       .. autodoxymethod:: simgrid::s4u::Comm::detach()
1788       .. autodoxymethod:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
1789       .. autodoxymethod:: simgrid::s4u::Comm::set_rate(double rate)
1790       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff)
1791       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
1792       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data_size(size_t size)
1793       .. autodoxymethod:: simgrid::s4u::Comm::set_tracing_category(const std::string &category)
1794
1795 Life cycle
1796 ----------
1797
1798 .. tabs::
1799
1800    .. group-tab:: C++
1801
1802       .. autodoxymethod:: simgrid::s4u::Comm::cancel
1803       .. autodoxymethod:: simgrid::s4u::Comm::start
1804       .. autodoxymethod:: simgrid::s4u::Comm::test
1805       .. autodoxymethod:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr > *comms)
1806       .. autodoxymethod:: simgrid::s4u::Comm::wait
1807       .. autodoxymethod:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr > *comms)
1808       .. autodoxymethod:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr > *comms)
1809       .. autodoxymethod:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr > *comms_in, double timeout)
1810       .. autodoxymethod:: simgrid::s4u::Comm::wait_for
1811
1812    .. group-tab:: Python
1813
1814        .. automethod:: simgrid.Comm.test
1815        .. automethod:: simgrid.Comm.wait
1816        .. automethod:: simgrid.Comm.wait_all
1817        .. automethod:: simgrid.Comm.wait_any
1818
1819 Signals
1820 -------
1821
1822 .. tabs::
1823
1824    .. group-tab:: C++
1825
1826       .. autodoxyvar:: simgrid::s4u::Comm::on_completion
1827       .. autodoxyvar:: simgrid::s4u::Comm::on_receiver_start
1828       .. autodoxyvar:: simgrid::s4u::Comm::on_sender_start
1829
1830 .. _API_s4u_Exec:
1831
1832 =============
1833 ⁣  class Exec
1834 =============
1835
1836 .. autodoxyclass:: simgrid::s4u::Exec
1837
1838 Basic management
1839 ----------------
1840
1841 .. tabs::
1842
1843    .. group-tab:: C++
1844
1845       .. code-block:: C++
1846
1847          #include <simgrid/s4u/Exec.hpp>
1848
1849       .. doxygentypedef:: ExecPtr
1850
1851    .. group-tab:: Python
1852
1853       .. code:: Python
1854
1855          from simgrid import Exec
1856
1857 Querying info
1858 -------------
1859
1860 .. tabs::
1861
1862    .. group-tab:: C++
1863
1864       .. autodoxymethod:: simgrid::s4u::Exec::get_cost() const
1865       .. autodoxymethod:: simgrid::s4u::Exec::get_finish_time() const
1866       .. autodoxymethod:: simgrid::s4u::Exec::get_host() const
1867       .. autodoxymethod:: simgrid::s4u::Exec::get_host_number() const
1868       .. cpp:function:: double Exec::get_remaining()
1869
1870          On sequential executions, returns the amount of flops that remain to be done;
1871          This cannot be used on parallel executions.
1872
1873       .. autodoxymethod:: simgrid::s4u::Exec::get_remaining_ratio
1874       .. autodoxymethod:: simgrid::s4u::Exec::get_start_time() const
1875       .. autodoxymethod:: simgrid::s4u::Exec::set_bound(double bound)
1876       .. autodoxymethod:: simgrid::s4u::Exec::set_host
1877       .. autodoxymethod:: simgrid::s4u::Exec::set_priority(double priority)
1878
1879    .. group-tab:: Python
1880
1881        .. autoattribute:: simgrid.Exec.host
1882        .. autoattribute:: simgrid.Exec.remaining
1883        .. autoattribute:: simgrid.Exec.remaining_ratio
1884
1885 Life cycle
1886 ----------
1887
1888 .. tabs::
1889
1890    .. group-tab:: C++
1891
1892       .. autodoxymethod:: simgrid::s4u::Exec::cancel
1893       .. autodoxymethod:: simgrid::s4u::Exec::set_timeout(double timeout)
1894       .. autodoxymethod:: simgrid::s4u::Exec::start
1895       .. autodoxymethod:: simgrid::s4u::Exec::test
1896       .. autodoxymethod:: simgrid::s4u::Exec::wait
1897       .. autodoxymethod:: simgrid::s4u::Exec::wait_any(std::vector< ExecPtr > *execs)
1898       .. autodoxymethod:: simgrid::s4u::Exec::wait_any_for(std::vector< ExecPtr > *execs, double timeout)
1899       .. autodoxymethod:: simgrid::s4u::Exec::wait_for
1900
1901    .. group-tab:: Python
1902
1903        .. automethod:: simgrid.Exec.cancel
1904        .. automethod:: simgrid.Exec.start
1905        .. automethod:: simgrid.Exec.test
1906        .. automethod:: simgrid.Exec.wait
1907
1908 Signals
1909 -------
1910
1911 .. tabs::
1912
1913    .. group-tab:: C++
1914
1915       .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion
1916       .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_start
1917
1918 .. _API_s4u_Io:
1919
1920 ===========
1921 ⁣  class Io
1922 ===========
1923
1924 .. autodoxyclass:: simgrid::s4u::Io
1925
1926 Basic management
1927 ----------------
1928
1929 .. tabs::
1930
1931    .. group-tab:: C++
1932
1933       .. code-block:: C++
1934
1935          #include <simgrid/s4u/Io.hpp>
1936
1937       .. doxygentypedef:: IoPtr
1938
1939 Querying info
1940 -------------
1941
1942 .. tabs::
1943
1944    .. group-tab:: C++
1945
1946       .. autodoxymethod:: simgrid::s4u::Io::get_performed_ioops() const
1947       .. autodoxymethod:: simgrid::s4u::Io::get_remaining
1948
1949 Life cycle
1950 ----------
1951
1952 .. tabs::
1953
1954    .. group-tab:: C++
1955
1956       .. autodoxymethod:: simgrid::s4u::Io::cancel
1957       .. autodoxymethod:: simgrid::s4u::Io::start
1958       .. autodoxymethod:: simgrid::s4u::Io::test
1959       .. autodoxymethod:: simgrid::s4u::Io::wait
1960       .. autodoxymethod:: simgrid::s4u::Io::wait_for
1961
1962 .. _API_s4u_Synchronizations:
1963
1964 =======================
1965 Synchronization Objects
1966 =======================
1967
1968 .. _API_s4u_Mutex:
1969
1970 ==============
1971 ⁣  Mutex
1972 ==============
1973
1974 .. autodoxyclass:: simgrid::s4u::Mutex
1975
1976 Basic management
1977 ----------------
1978
1979    .. tabs::
1980
1981       .. group-tab:: C++
1982
1983          .. code-block:: C++
1984
1985             #include <simgrid/s4u/Mutex.hpp>
1986
1987          .. doxygentypedef:: MutexPtr
1988
1989          .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
1990          .. autodoxymethod:: simgrid::s4u::Mutex::create()
1991          .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
1992
1993       .. group-tab:: C
1994
1995          .. code-block:: C
1996
1997             #include <simgrid/mutex.h>
1998
1999          .. doxygentypedef:: sg_mutex_t
2000          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2001
2002             Pointer to a constant mutex object.
2003
2004          .. autodoxymethod:: sg_mutex_init()
2005          .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
2006
2007 Locking
2008 -------
2009
2010    .. tabs::
2011
2012       .. group-tab:: C++
2013
2014          .. autodoxymethod:: simgrid::s4u::Mutex::lock()
2015          .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
2016          .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
2017
2018       .. group-tab:: C
2019
2020          .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
2021          .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
2022          .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
2023
2024 .. _API_s4u_Barrier:
2025
2026 ================
2027 ⁣  Barrier
2028 ================
2029
2030 .. autodoxyclass:: simgrid::s4u::Barrier
2031
2032    .. tabs::
2033
2034       .. group-tab:: C++
2035
2036          .. code-block:: C++
2037
2038             #include <simgrid/s4u/Barrier.hpp>
2039
2040          .. doxygentypedef:: BarrierPtr
2041
2042          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2043          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2044          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
2045
2046       .. group-tab:: C
2047
2048          .. code-block:: C
2049
2050             #include <simgrid/barrier.hpp>
2051
2052          .. doxygentypedef:: sg_bar_t
2053          .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2054
2055             Pointer to a constant barrier object.
2056
2057          .. autodoxymethod:: sg_barrier_init(unsigned int count)
2058          .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
2059          .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
2060
2061
2062 .. _API_s4u_ConditionVariable:
2063
2064 ==========================
2065 ⁣  Condition variable
2066 ==========================
2067
2068 .. autodoxyclass:: simgrid::s4u::ConditionVariable
2069
2070 Basic management
2071 ----------------
2072
2073    .. tabs::
2074
2075       .. group-tab:: C++
2076
2077          .. code-block:: C++
2078
2079             #include <simgrid/s4u/ConditionVariable.hpp>
2080
2081          .. doxygentypedef:: ConditionVariablePtr
2082
2083          .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
2084
2085       .. group-tab:: C
2086
2087          .. code-block:: C
2088
2089             #include <simgrid/cond.h>
2090
2091          .. doxygentypedef:: sg_cond_t
2092          .. autodoxymethod:: sg_cond_init
2093          .. autodoxymethod:: sg_cond_destroy
2094
2095 Waiting and notifying
2096 ---------------------
2097
2098    .. tabs::
2099
2100       .. group-tab:: C++
2101
2102          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
2103          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
2104          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2105          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2106          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2107          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2108          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2109          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2110          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2111          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2112          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2113          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2114          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2115
2116       .. group-tab:: C
2117
2118          .. autodoxymethod:: sg_cond_notify_all
2119          .. autodoxymethod:: sg_cond_notify_one
2120          .. autodoxymethod:: sg_cond_wait
2121          .. autodoxymethod:: sg_cond_wait_for
2122
2123 .. _API_s4u_Semaphore:
2124
2125 ==================
2126 ⁣  Semaphore
2127 ==================
2128
2129 .. autodoxyclass:: simgrid::s4u::Semaphore
2130
2131
2132 Basic management
2133 ----------------
2134
2135    .. tabs::
2136
2137       .. group-tab:: C++
2138
2139          .. code-block:: C++
2140
2141             #include <simgrid/s4u/Semaphore.hpp>
2142
2143          .. doxygentypedef:: SemaphorePtr
2144          .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
2145          .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
2146          .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2147
2148       .. group-tab:: C
2149
2150          .. code-block:: C
2151
2152             #include <simgrid/semaphore.h>
2153
2154          .. doxygentypedef:: sg_sem_t
2155          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2156
2157             Pointer to a constant semaphore object.
2158
2159          .. autodoxymethod:: sg_sem_init(int initial_value)
2160          .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
2161
2162 Locking
2163 -------
2164
2165    .. tabs::
2166
2167       .. group-tab:: C++
2168
2169          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
2170          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2171          .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity() const
2172          .. autodoxymethod:: simgrid::s4u::Semaphore::release()
2173          .. autodoxymethod:: simgrid::s4u::Semaphore::would_block() const
2174
2175       .. group-tab:: C
2176
2177          .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
2178          .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2179          .. autodoxymethod:: sg_sem_get_capacity(const_sg_sem_t sem)
2180          .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
2181          .. autodoxymethod:: sg_sem_would_block(const_sg_sem_t sem)
2182
2183 .. |hr| raw:: html
2184
2185    <hr />