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 a 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 an 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_data(const_sg_actor_t actor)
 513       .. autodoxymethod:: sg_actor_data_set(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(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()
 583       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
 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(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 Actor&, const 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(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_data()
 648       .. autodoxymethod:: sg_actor_self_data_set(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(double flops_amounts)
 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
 764       .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
 765       .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
 766       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
 767       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 768       .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
 769       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
 770       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
 771
 772    .. group-tab:: Python
 773
 774        .. automethod:: simgrid.Engine.load_deployment
 775        .. automethod:: simgrid.Engine.load_platform
 776        .. automethod:: simgrid.Engine.register_actor
 777
 778    .. group-tab:: C
 779
 780       .. autodoxymethod:: simgrid_init
 781
 782       .. autodoxymethod:: simgrid_load_deployment
 783       .. autodoxymethod:: simgrid_load_platform
 784       .. autodoxymethod:: simgrid_register_default
 785       .. autodoxymethod:: simgrid_register_function
 786
 787 Run the simulation
 788 ------------------
 789
 790 .. tabs::
 791
 792    .. group-tab:: C++
 793
 794       .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
 795       .. autodoxymethod:: simgrid::s4u::Engine::run()
 796
 797    .. group-tab:: Python
 798
 799       .. automethod:: simgrid.Engine.get_clock
 800       .. automethod:: simgrid.Engine.run
 801
 802    .. group-tab:: C
 803
 804       .. autodoxymethod:: simgrid_get_clock
 805       .. autodoxymethod:: simgrid_run
 806
 807 Retrieving actors
 808 -----------------
 809
 810 .. tabs::
 811
 812    .. group-tab:: C++
 813
 814       .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
 815       .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
 816       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
 817
 818    .. group-tab:: C
 819
 820       .. autodoxymethod:: simgrid_get_actor_count()
 821
 822 Retrieving hosts
 823 ----------------
 824
 825 .. tabs::
 826
 827    .. group-tab:: C++
 828
 829       .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
 830       .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
 831       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
 832       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
 833       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
 834
 835    .. group-tab:: Python
 836
 837       .. automethod:: simgrid.Engine.get_all_hosts
 838
 839    .. group-tab:: C
 840
 841       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 842
 843 Retrieving links
 844 ----------------
 845
 846 .. tabs::
 847
 848    .. group-tab:: C++
 849
 850       .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
 851       .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
 852       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
 853       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
 854       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
 855
 856 Interacting with the routing
 857 ----------------------------
 858
 859 .. tabs::
 860
 861    .. group-tab:: C++
 862
 863       .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
 864       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
 865       .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
 866       .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
 867       .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
 868       .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
 869       .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 870
 871 Signals
 872 -------
 873
 874 .. tabs::
 875
 876    .. group-tab:: C++
 877
 878       .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
 879       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
 880       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
 881       .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
 882       .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
 883
 884 .. _API_s4u_Mailbox:
 885
 886 ================
 887 ⁣  class Mailbox
 888 ================
 889
 890 .. autodoxyclass:: simgrid::s4u::Mailbox
 891
 892 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 893
 894 Basic management
 895 ----------------
 896
 897 .. tabs::
 898
 899    .. group-tab:: C++
 900
 901       .. code-block:: C++
 902
 903          #include <simgrid/s4u/Mailbox.hpp>
 904
 905       Note that there is no MailboxPtr type, and that you cannot use the RAII
 906       idiom on mailboxes because they are internal objects to the simulation
 907       engine. Once created, there is no way to destroy a mailbox before the end
 908       of the simulation.
 909
 910       .. autodoxymethod:: simgrid::s4u::Mailbox::by_name(const std::string &name)
 911
 912    .. group-tab:: Python
 913
 914       .. automethod:: simgrid.Mailbox.by_name
 915
 916 Querying info
 917 -------------
 918
 919 .. tabs::
 920
 921    .. group-tab:: C++
 922
 923       .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname() const
 924       .. autodoxymethod:: simgrid::s4u::Mailbox::get_name() const
 925
 926    .. group-tab:: Python
 927
 928       .. autoattribute:: simgrid.Mailbox.name
 929
 930 Sending data
 931 ------------
 932
 933 .. tabs::
 934
 935    .. group-tab:: C++
 936
 937       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
 938       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
 939       .. autodoxymethod:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
 940       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init()
 941       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
 942
 943    .. group-tab:: Python
 944
 945       .. automethod:: simgrid.Mailbox.put
 946       .. automethod:: simgrid.Mailbox.put_async
 947
 948
 949 Receiving data
 950 --------------
 951
 952 .. tabs::
 953
 954    .. group-tab:: C++
 955
 956       .. autodoxymethod:: simgrid::s4u::Mailbox::empty()
 957       .. autodoxymethod:: simgrid::s4u::Mailbox::front()
 958       .. autodoxymethod:: simgrid::s4u::Mailbox::get()
 959       .. autodoxymethod:: simgrid::s4u::Mailbox::get(double timeout)
 960       .. autodoxymethod:: simgrid::s4u::Mailbox::get_async(void **data)
 961       .. autodoxymethod:: simgrid::s4u::Mailbox::get_init()
 962       .. autodoxymethod:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
 963       .. autodoxymethod:: simgrid::s4u::Mailbox::listen()
 964       .. autodoxymethod:: simgrid::s4u::Mailbox::ready()
 965
 966    .. group-tab:: Python
 967
 968        .. automethod:: simgrid.Mailbox.get
 969
 970    .. group-tab:: C
 971
 972       .. autodoxymethod:: sg_mailbox_listen(const char *alias)
 973
 974 Receiving actor
 975 ---------------
 976
 977 See :ref:`s4u_receiving_actor`.
 978
 979 .. tabs::
 980
 981    .. group-tab:: C++
 982
 983       .. autodoxymethod:: simgrid::s4u::Mailbox::get_receiver()
 984       .. autodoxymethod:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
 985
 986    .. group-tab:: C
 987
 988       .. autodoxymethod:: sg_mailbox_set_receiver(const char *alias)
 989
 990 .. _API_s4u_Resource:
 991
 992 =========
 993 Resources
 994 =========
 995
 996 .. _API_s4u_Disk:
 997
 998 =============
 999 ⁣  class Disk
1000 =============
1001
1002 .. autodoxyclass:: simgrid::s4u::Disk
1003
1004 Basic management
1005 ----------------
1006
1007 .. tabs::
1008
1009    .. group-tab:: C++
1010
1011       .. code-block:: C++
1012
1013          #include <simgrid/s4u/Disk.hpp>
1014
1015       Note that there is no DiskPtr type, and that you cannot use the RAII
1016       idiom on disks because SimGrid does not allow (yet) to create nor
1017       destroy resources once the simulation is started.
1018
1019
1020 Querying info
1021 -------------
1022
1023 .. tabs::
1024
1025    .. group-tab:: C++
1026
1027       .. autodoxymethod:: simgrid::s4u::Disk::get_cname() const
1028       .. autodoxymethod:: simgrid::s4u::Disk::get_host() const
1029       .. autodoxymethod:: simgrid::s4u::Disk::get_name() const
1030       .. autodoxymethod:: simgrid::s4u::Disk::get_properties() const
1031       .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key) const
1032       .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth() const
1033       .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth() const
1034       .. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1035
1036 I/O operations
1037 --------------
1038
1039 .. tabs::
1040
1041    .. group-tab:: C++
1042
1043       .. autodoxymethod:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type)
1044       .. autodoxymethod:: simgrid::s4u::Disk::read(sg_size_t size)
1045       .. autodoxymethod:: simgrid::s4u::Disk::read_async(sg_size_t size)
1046       .. autodoxymethod:: simgrid::s4u::Disk::write(sg_size_t size)
1047       .. autodoxymethod:: simgrid::s4u::Disk::write_async(sg_size_t size)
1048
1049 Signals
1050 -------
1051
1052 .. tabs::
1053
1054    .. group-tab:: C++
1055
1056       .. autodoxyvar:: simgrid::s4u::Disk::on_creation
1057       .. autodoxyvar:: simgrid::s4u::Disk::on_destruction
1058       .. autodoxyvar:: simgrid::s4u::Disk::on_state_change
1059
1060
1061 .. _API_s4u_Host:
1062
1063 =============
1064 ⁣  class Host
1065 =============
1066
1067 .. autodoxyclass:: simgrid::s4u::Host
1068
1069 Basic management
1070 ----------------
1071
1072 .. tabs::
1073
1074    .. group-tab:: C++
1075
1076       .. code-block:: C++
1077
1078          #include <simgrid/s4u/Host.hpp>
1079
1080       Note that there is no HostPtr type, and that you cannot use the RAII
1081       idiom on hosts because SimGrid does not allow (yet) to create nor
1082       destroy resources once the simulation is started.
1083
1084       .. autodoxymethod:: simgrid::s4u::Host::destroy()
1085
1086    .. group-tab:: Python
1087
1088       .. code:: Python
1089
1090          from simgrid import Host
1091
1092    .. group-tab:: C
1093
1094       .. code:: C
1095
1096          #include <simgrid/host.h>
1097
1098       .. doxygentypedef:: sg_host_t
1099       .. cpp:type:: const s4u_Host* const_sg_host_t
1100
1101          Pointer to a constant host object.
1102
1103 Retrieving hosts
1104 ----------------
1105
1106 .. tabs::
1107
1108    .. group-tab:: C++
1109
1110       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1111
1112       .. autodoxymethod:: simgrid::s4u::Host::by_name(const std::string &name)
1113       .. autodoxymethod:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1114       .. autodoxymethod:: simgrid::s4u::Host::current()
1115
1116    .. group-tab:: Python
1117
1118       See also :py:func:`simgrid.Engine.get_all_hosts`.
1119
1120       .. automethod:: simgrid.Host.by_name
1121       .. automethod:: simgrid.Host.current
1122
1123    .. group-tab:: C
1124
1125       .. autodoxymethod:: sg_host_by_name(const char *name)
1126       .. autodoxymethod:: sg_host_count()
1127       .. autodoxymethod:: sg_host_list()
1128       .. autodoxymethod:: sg_hosts_as_dynar()
1129
1130 Querying info
1131 -------------
1132
1133 .. tabs::
1134
1135    .. group-tab:: C++
1136
1137       .. autodoxymethod:: simgrid::s4u::Host::get_cname() const
1138       .. autodoxymethod:: simgrid::s4u::Host::get_core_count() const
1139       .. autodoxymethod:: simgrid::s4u::Host::get_name() const
1140       .. autodoxymethod:: simgrid::s4u::Host::get_available_speed() const
1141       .. autodoxymethod:: simgrid::s4u::Host::get_load() const
1142       .. autodoxymethod:: simgrid::s4u::Host::get_speed() const
1143
1144    .. group-tab:: Python
1145
1146       .. autoattribute:: simgrid.Host.name
1147       .. autoattribute:: simgrid.Host.load
1148       .. autoattribute:: simgrid.Host.pstate
1149       .. autoattribute:: simgrid.Host.speed
1150
1151    .. group-tab:: C
1152
1153       .. autodoxymethod:: sg_host_core_count(const_sg_host_t host)
1154       .. autodoxymethod:: sg_host_dump(const_sg_host_t ws)
1155       .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
1156       .. autodoxymethod:: sg_host_load(const_sg_host_t host)
1157       .. autodoxymethod:: sg_host_speed(const_sg_host_t host)
1158
1159 User data and properties
1160 ------------------------
1161
1162 .. tabs::
1163
1164    .. group-tab:: C++
1165
1166       .. autodoxymethod:: simgrid::s4u::Host::get_properties() const
1167       .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key) const
1168       .. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::map< std::string, std::string > &properties)
1169       .. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1170
1171    .. group-tab:: C
1172
1173       .. autodoxymethod:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1174       .. autodoxymethod:: sg_host_get_properties(const_sg_host_t host)
1175       .. autodoxymethod:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1176       .. autodoxymethod:: sg_host_extension_create(void(*deleter)(void *))
1177       .. autodoxymethod:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1178
1179 Retrieving components
1180 ---------------------
1181
1182 .. tabs::
1183
1184    .. group-tab:: C++
1185
1186       .. autodoxymethod:: simgrid::s4u::Host::add_disk(Disk *disk)
1187       .. autodoxymethod:: simgrid::s4u::Host::get_actor_count() const
1188       .. autodoxymethod:: simgrid::s4u::Host::get_all_actors() const
1189       .. autodoxymethod:: simgrid::s4u::Host::get_disks() const
1190       .. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1191
1192    .. group-tab:: C
1193
1194       .. autodoxymethod:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1195
1196 On/Off
1197 ------
1198
1199 .. tabs::
1200
1201    .. group-tab:: C++
1202
1203       .. autodoxymethod:: simgrid::s4u::Host::is_on() const
1204       .. autodoxymethod:: simgrid::s4u::Host::turn_off()
1205       .. autodoxymethod:: simgrid::s4u::Host::turn_on()
1206
1207    .. group-tab:: C
1208
1209       .. autodoxymethod:: sg_host_is_on(const_sg_host_t host)
1210       .. autodoxymethod:: sg_host_turn_off(sg_host_t host)
1211       .. autodoxymethod:: sg_host_turn_on(sg_host_t host)
1212
1213 DVFS
1214 ----
1215
1216 .. tabs::
1217
1218    .. group-tab:: C++
1219
1220       .. autodoxymethod:: simgrid::s4u::Host::get_pstate() const
1221       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count() const
1222       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
1223       .. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
1224       .. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1225       .. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1226
1227    .. group-tab:: Python
1228
1229       .. automethod:: simgrid.Host.get_pstate_count
1230       .. automethod:: simgrid.Host.get_pstate_speed
1231
1232    .. group-tab:: C
1233
1234       .. autodoxymethod:: sg_host_get_available_speed(const_sg_host_t host)
1235       .. autodoxymethod:: sg_host_get_nb_pstates(const_sg_host_t host)
1236       .. autodoxymethod:: sg_host_get_pstate(const_sg_host_t host)
1237       .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1238       .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
1239
1240 Execution
1241 ---------
1242
1243 .. tabs::
1244
1245    .. group-tab:: C++
1246
1247       .. autodoxymethod:: simgrid::s4u::Host::exec_async(double flops_amounts)
1248       .. autodoxymethod:: simgrid::s4u::Host::execute(double flops)
1249       .. autodoxymethod:: simgrid::s4u::Host::execute(double flops, double priority)
1250
1251 Platform and routing
1252 --------------------
1253
1254 .. tabs::
1255
1256    .. group-tab:: C++
1257
1258       .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
1259       .. autodoxymethod:: simgrid::s4u::Host::get_netpoint() const
1260       .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link *> &links, double *latency) const
1261       .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl *> &links, double *latency) const
1262       .. autodoxymethod:: simgrid::s4u::Host::sendto(Host *dest, double byte_amount)
1263       .. autodoxymethod:: simgrid::s4u::Host::sendto_async(Host *dest, double byte_amount)
1264
1265    .. group-tab:: C
1266
1267       .. autodoxymethod:: sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1268       .. autodoxymethod:: sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1269       .. autodoxymethod:: sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
1270       .. autodoxymethod:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1271
1272 Signals
1273 -------
1274
1275 .. tabs::
1276
1277    .. group-tab:: C++
1278
1279       .. autodoxyvar:: simgrid::s4u::Host::on_creation
1280       .. autodoxyvar:: simgrid::s4u::Host::on_destruction
1281       .. autodoxyvar:: simgrid::s4u::Host::on_speed_change
1282       .. autodoxyvar:: simgrid::s4u::Host::on_state_change
1283
1284 .. _API_s4u_Link:
1285
1286 =============
1287 ⁣  class Link
1288 =============
1289
1290 .. autodoxyclass:: simgrid::s4u::Link
1291
1292 Basic management
1293 ----------------
1294
1295 .. tabs::
1296
1297    .. group-tab:: C++
1298
1299       .. code-block:: C++
1300
1301          #include <simgrid/s4u/Link.hpp>
1302
1303       Note that there is no LinkPtr type, and that you cannot use the RAII
1304       idiom on hosts because SimGrid does not allow (yet) to create nor
1305       destroy resources once the simulation is started.
1306
1307    .. group-tab:: Python
1308
1309       .. code:: Python
1310
1311          from simgrid import Link
1312
1313    .. group-tab:: C
1314
1315       .. code:: C
1316
1317          #include <simgrid/link.h>
1318
1319       .. doxygentypedef:: sg_link_t
1320       .. cpp:type:: const s4u_Link* const_sg_link_t
1321
1322          Pointer to a constant link object.
1323
1324 Retrieving links
1325 ----------------
1326
1327 .. tabs::
1328
1329    .. group-tab:: C++
1330
1331       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1332
1333       .. autodoxymethod:: simgrid::s4u::Link::by_name(const std::string &name)
1334       .. autodoxymethod:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1335
1336    .. group-tab:: C
1337
1338       .. autodoxymethod:: sg_link_by_name(const char *name)
1339       .. autodoxymethod:: sg_link_count()
1340       .. autodoxymethod:: sg_link_list()
1341
1342 Querying info
1343 --------------
1344
1345 .. tabs::
1346
1347    .. group-tab:: C++
1348
1349       .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth() const
1350       .. autodoxymethod:: simgrid::s4u::Link::get_cname() const
1351       .. autodoxymethod:: simgrid::s4u::Link::get_latency() const
1352       .. autodoxymethod:: simgrid::s4u::Link::get_name() const
1353       .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy() const
1354       .. autodoxymethod:: simgrid::s4u::Link::get_usage() const
1355       .. autodoxymethod:: simgrid::s4u::Link::is_used() const
1356
1357    .. group-tab:: C
1358
1359       .. autodoxymethod:: sg_link_bandwidth(const_sg_link_t link)
1360       .. autodoxymethod:: sg_link_is_shared(const_sg_link_t link)
1361       .. autodoxymethod:: sg_link_latency(const_sg_link_t link)
1362       .. autodoxymethod:: sg_link_name(const_sg_link_t link)
1363
1364 User data and properties
1365 ------------------------
1366
1367 .. tabs::
1368
1369    .. group-tab:: C++
1370
1371       .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key) const
1372       .. autodoxymethod:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1373
1374    .. group-tab:: C
1375
1376       .. autodoxymethod:: sg_link_data(const_sg_link_t link)
1377       .. autodoxymethod:: sg_link_data_set(sg_link_t link, void *data)
1378
1379 On/Off
1380 ------
1381
1382 .. tabs::
1383
1384    .. group-tab:: C++
1385
1386       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1387
1388       .. autodoxymethod:: simgrid::s4u::Link::is_on() const
1389       .. autodoxymethod:: simgrid::s4u::Link::turn_off()
1390       .. autodoxymethod:: simgrid::s4u::Link::turn_on()
1391
1392 Dynamic profiles
1393 ----------------
1394
1395 .. tabs::
1396
1397    .. group-tab:: C++
1398
1399       .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1400       .. autodoxymethod:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1401       .. autodoxymethod:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1402
1403 Signals
1404 -------
1405
1406 .. tabs::
1407
1408    .. group-tab:: C++
1409
1410       .. autodoxyvar:: simgrid::s4u::Link::on_bandwidth_change
1411       .. cpp:var:: xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> Link::on_communicate
1412       .. autodoxyvar:: simgrid::s4u::Link::on_communication_state_change
1413       .. autodoxyvar:: simgrid::s4u::Link::on_creation
1414       .. autodoxyvar:: simgrid::s4u::Link::on_destruction
1415       .. autodoxyvar:: simgrid::s4u::Link::on_state_change
1416
1417 .. _API_s4u_NetZone:
1418
1419 ================
1420 ⁣  class NetZone
1421 ================
1422
1423 .. autodoxyclass:: simgrid::s4u::NetZone
1424
1425 Basic management
1426 ----------------
1427
1428 .. tabs::
1429
1430    .. group-tab:: C++
1431
1432       .. code-block:: C++
1433
1434          #include <simgrid/s4u/NetZone.hpp>
1435
1436       Note that there is no NetZonePtr type, and that you cannot use the RAII
1437       idiom on network zones because SimGrid does not allow (yet) to create nor
1438       destroy resources once the simulation is started.
1439
1440    .. group-tab:: C
1441
1442       .. code:: C
1443
1444          #include <simgrid/zone.h>
1445
1446       .. doxygentypedef:: sg_netzone_t
1447       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1448
1449          Pointer to a constant network zone object.
1450
1451 Retrieving zones
1452 ----------------
1453
1454 .. tabs::
1455
1456    .. group-tab:: C++
1457
1458       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1459       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1460       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1461
1462    .. group-tab:: C
1463
1464       .. autodoxymethod:: sg_zone_get_by_name(const char *name)
1465       .. autodoxymethod:: sg_zone_get_root()
1466
1467 Querying info
1468 --------------
1469
1470 .. tabs::
1471
1472    .. group-tab:: C++
1473
1474       .. autodoxymethod:: simgrid::s4u::NetZone::get_cname() const
1475       .. autodoxymethod:: simgrid::s4u::NetZone::get_name() const
1476
1477    .. group-tab:: C
1478
1479       .. autodoxymethod:: sg_zone_get_name(const_sg_netzone_t zone)
1480
1481 User data and properties
1482 ------------------------
1483
1484 .. tabs::
1485
1486    .. group-tab:: C++
1487
1488       .. autodoxymethod:: simgrid::s4u::NetZone::get_properties() const
1489       .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1490       .. autodoxymethod:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1491
1492    .. group-tab:: C
1493
1494       .. autodoxymethod:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1495       .. autodoxymethod:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1496
1497 Retrieving components
1498 ---------------------
1499
1500 .. tabs::
1501
1502    .. group-tab:: C++
1503
1504       .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts() const
1505       .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count() const
1506
1507    .. group-tab:: C
1508
1509       .. autodoxymethod:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1510
1511 Routing data
1512 ------------
1513
1514 .. tabs::
1515
1516    .. group-tab:: C++
1517
1518       .. autodoxymethod:: simgrid::s4u::NetZone::add_bypass_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
1519       .. autodoxymethod:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1520       .. autodoxymethod:: simgrid::s4u::NetZone::add_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
1521       .. autodoxymethod:: simgrid::s4u::NetZone::get_children() const
1522       .. autodoxymethod:: simgrid::s4u::NetZone::get_father()
1523
1524    .. group-tab:: C
1525
1526       .. autodoxymethod:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1527
1528 Signals
1529 -------
1530
1531 .. tabs::
1532
1533   .. group-tab:: C++
1534
1535      .. autodoxyvar:: simgrid::s4u::NetZone::on_creation
1536      .. autodoxyvar:: simgrid::s4u::NetZone::on_route_creation
1537      .. autodoxyvar:: simgrid::s4u::NetZone::on_seal
1538
1539 .. _API_s4u_VirtualMachine:
1540
1541 =======================
1542 ⁣  class VirtualMachine
1543 =======================
1544
1545
1546 .. autodoxyclass:: simgrid::s4u::VirtualMachine
1547
1548 Basic management
1549 ----------------
1550 .. tabs::
1551
1552    .. group-tab:: C++
1553
1554       .. code-block:: C++
1555
1556          #include <simgrid/s4u/VirtualMachine.hpp>
1557
1558       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1559       idiom on virtual machines. There is no good reason for that and should change in the future.
1560
1561    .. group-tab:: C
1562
1563       .. code:: C
1564
1565          #include <simgrid/vm.h>
1566
1567       .. doxygentypedef:: sg_vm_t
1568       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1569
1570          Pointer to a constant virtual machine object.
1571
1572 Creating VMs
1573 ------------
1574
1575 .. tabs::
1576
1577    .. group-tab:: C++
1578
1579       .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1580       .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1581       .. autodoxymethod:: simgrid::s4u::VirtualMachine::destroy
1582
1583    .. group-tab:: C
1584
1585       .. autodoxymethod:: sg_vm_create_core
1586       .. autodoxymethod:: sg_vm_create_multicore
1587       .. autodoxymethod:: sg_vm_destroy
1588
1589 Querying info
1590 --------------
1591
1592 .. tabs::
1593
1594    .. group-tab:: C++
1595
1596       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_pm() const
1597       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_ramsize() const
1598       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_state()
1599
1600       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1601       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1602       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1603
1604    .. group-tab:: C
1605
1606       .. autodoxymethod:: sg_vm_get_ramsize(const_sg_vm_t vm)
1607       .. autodoxymethod:: sg_vm_set_bound(sg_vm_t vm, double bound)
1608       .. autodoxymethod:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1609
1610       .. autodoxymethod:: sg_vm_get_name
1611       .. autodoxymethod:: sg_vm_get_pm
1612       .. autodoxymethod:: sg_vm_is_created
1613       .. autodoxymethod:: sg_vm_is_running
1614       .. autodoxymethod:: sg_vm_is_suspended
1615
1616 Life cycle
1617 ----------
1618
1619 .. tabs::
1620
1621    .. group-tab:: C++
1622
1623       .. autodoxymethod:: simgrid::s4u::VirtualMachine::resume()
1624       .. autodoxymethod:: simgrid::s4u::VirtualMachine::shutdown()
1625       .. autodoxymethod:: simgrid::s4u::VirtualMachine::start()
1626       .. autodoxymethod:: simgrid::s4u::VirtualMachine::suspend()
1627
1628    .. group-tab:: C
1629
1630       .. autodoxymethod:: sg_vm_start
1631       .. autodoxymethod:: sg_vm_suspend
1632       .. autodoxymethod:: sg_vm_resume
1633       .. autodoxymethod:: sg_vm_shutdown
1634
1635 Signals
1636 -------
1637
1638 .. tabs::
1639
1640    .. group-tab:: C++
1641
1642       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_end
1643       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_start
1644       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_resume
1645       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_shutdown
1646       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_start
1647       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_started
1648       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_suspend
1649
1650 .. _API_s4u_Activity:
1651
1652 ==============
1653 class Activity
1654 ==============
1655
1656 .. autodoxyclass:: simgrid::s4u::Activity
1657
1658    **Known subclasses:**
1659    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1660    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1661    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1662    See also the :ref:`section on activities <s4u_Activities>` above.
1663
1664 Basic management
1665 ----------------
1666
1667 .. tabs::
1668
1669    .. group-tab:: C++
1670
1671       .. code-block:: C++
1672
1673          #include <simgrid/s4u/Activity.hpp>
1674
1675       .. doxygentypedef:: ActivityPtr
1676
1677 Querying info
1678 -------------
1679
1680 .. tabs::
1681
1682    .. group-tab:: C++
1683
1684       .. autodoxymethod:: simgrid::s4u::Activity::get_cname
1685       .. autodoxymethod:: simgrid::s4u::Activity::get_name
1686       .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() const
1687       .. autodoxymethod:: simgrid::s4u::Activity::get_state() const
1688       .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
1689       .. autodoxymethod:: simgrid::s4u::Activity::set_state(Activity::State state)
1690
1691
1692 Activities life cycle
1693 ---------------------
1694
1695 .. tabs::
1696
1697    .. group-tab:: C++
1698
1699       .. autodoxymethod:: simgrid::s4u::Activity::start
1700       .. autodoxymethod:: simgrid::s4u::Activity::cancel
1701       .. autodoxymethod:: simgrid::s4u::Activity::test
1702       .. autodoxymethod:: simgrid::s4u::Activity::wait
1703       .. autodoxymethod:: simgrid::s4u::Activity::wait_for
1704       .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
1705       .. autodoxymethod:: simgrid::s4u::Activity::vetoable_start()
1706
1707 .. _API_s4u_Comm:
1708
1709 =============
1710 ⁣  class Comm
1711 =============
1712
1713 .. autodoxyclass:: simgrid::s4u::Comm
1714
1715 Basic management
1716 ----------------
1717
1718 .. tabs::
1719
1720    .. group-tab:: C++
1721
1722       .. code-block:: C++
1723
1724          #include <simgrid/s4u/Comm.hpp>
1725
1726       .. doxygentypedef:: CommPtr
1727
1728    .. group-tab:: Python
1729
1730       .. code:: Python
1731
1732          from simgrid import Comm
1733
1734 Querying info
1735 -------------
1736
1737 .. tabs::
1738
1739    .. group-tab:: C++
1740
1741       .. autodoxymethod:: simgrid::s4u::Comm::get_dst_data_size() const
1742       .. autodoxymethod:: simgrid::s4u::Comm::get_mailbox() const
1743       .. autodoxymethod:: simgrid::s4u::Comm::get_sender() const
1744       .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff)
1745       .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
1746       .. autodoxymethod:: simgrid::s4u::Comm::detach()
1747       .. autodoxymethod:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
1748       .. autodoxymethod:: simgrid::s4u::Comm::set_rate(double rate)
1749       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff)
1750       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
1751       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data_size(size_t size)
1752       .. autodoxymethod:: simgrid::s4u::Comm::set_tracing_category(const std::string &category)
1753
1754 Life cycle
1755 ----------
1756
1757 .. tabs::
1758
1759    .. group-tab:: C++
1760
1761       .. autodoxymethod:: simgrid::s4u::Comm::cancel
1762       .. autodoxymethod:: simgrid::s4u::Comm::start
1763       .. autodoxymethod:: simgrid::s4u::Comm::test
1764       .. autodoxymethod:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr > *comms)
1765       .. autodoxymethod:: simgrid::s4u::Comm::wait
1766       .. autodoxymethod:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr > *comms)
1767       .. autodoxymethod:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr > *comms)
1768       .. autodoxymethod:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr > *comms_in, double timeout)
1769       .. autodoxymethod:: simgrid::s4u::Comm::wait_for
1770
1771    .. group-tab:: Python
1772
1773        .. automethod:: simgrid.Comm.test
1774        .. automethod:: simgrid.Comm.wait
1775        .. automethod:: simgrid.Comm.wait_all
1776        .. automethod:: simgrid.Comm.wait_any
1777
1778 Signals
1779 -------
1780
1781 .. tabs::
1782
1783    .. group-tab:: C++
1784
1785       .. autodoxyvar:: simgrid::s4u::Comm::on_completion
1786       .. autodoxyvar:: simgrid::s4u::Comm::on_receiver_start
1787       .. autodoxyvar:: simgrid::s4u::Comm::on_sender_start
1788
1789 .. _API_s4u_Exec:
1790
1791 =============
1792 ⁣  class Exec
1793 =============
1794
1795 .. autodoxyclass:: simgrid::s4u::Exec
1796
1797 Basic management
1798 ----------------
1799
1800 .. tabs::
1801
1802    .. group-tab:: C++
1803
1804       .. code-block:: C++
1805
1806          #include <simgrid/s4u/Exec.hpp>
1807
1808       .. doxygentypedef:: ExecPtr
1809
1810    .. group-tab:: Python
1811
1812       .. code:: Python
1813
1814          from simgrid import Exec
1815
1816 Querying info
1817 -------------
1818
1819 .. tabs::
1820
1821    .. group-tab:: C++
1822
1823       .. autodoxymethod:: simgrid::s4u::Exec::get_cost() const
1824       .. autodoxymethod:: simgrid::s4u::Exec::get_finish_time() const
1825       .. autodoxymethod:: simgrid::s4u::Exec::get_host() const
1826       .. autodoxymethod:: simgrid::s4u::Exec::get_host_number() const
1827       .. cpp:function:: double Exec::get_remaining()
1828
1829          On sequential executions, returns the amount of flops that remain to be done;
1830          This cannot be used on parallel executions.
1831
1832       .. autodoxymethod:: simgrid::s4u::Exec::get_remaining_ratio
1833       .. autodoxymethod:: simgrid::s4u::Exec::get_start_time() const
1834       .. autodoxymethod:: simgrid::s4u::Exec::set_bound(double bound)
1835       .. autodoxymethod:: simgrid::s4u::Exec::set_host
1836       .. autodoxymethod:: simgrid::s4u::Exec::set_priority(double priority)
1837
1838    .. group-tab:: Python
1839
1840        .. autoattribute:: simgrid.Exec.host
1841        .. autoattribute:: simgrid.Exec.remaining
1842        .. autoattribute:: simgrid.Exec.remaining_ratio
1843
1844 Life cycle
1845 ----------
1846
1847 .. tabs::
1848
1849    .. group-tab:: C++
1850
1851       .. autodoxymethod:: simgrid::s4u::Exec::cancel
1852       .. autodoxymethod:: simgrid::s4u::Exec::set_timeout(double timeout)
1853       .. autodoxymethod:: simgrid::s4u::Exec::start
1854       .. autodoxymethod:: simgrid::s4u::Exec::test
1855       .. autodoxymethod:: simgrid::s4u::Exec::wait
1856       .. autodoxymethod:: simgrid::s4u::Exec::wait_any(std::vector< ExecPtr > *execs)
1857       .. autodoxymethod:: simgrid::s4u::Exec::wait_any_for(std::vector< ExecPtr > *execs, double timeout)
1858       .. autodoxymethod:: simgrid::s4u::Exec::wait_for
1859
1860    .. group-tab:: Python
1861
1862        .. automethod:: simgrid.Exec.cancel
1863        .. automethod:: simgrid.Exec.start
1864        .. automethod:: simgrid.Exec.test
1865        .. automethod:: simgrid.Exec.wait
1866
1867 Signals
1868 -------
1869
1870 .. tabs::
1871
1872    .. group-tab:: C++
1873
1874       .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion
1875       .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_start
1876
1877 .. _API_s4u_Io:
1878
1879 ===========
1880 ⁣  class Io
1881 ===========
1882
1883 .. autodoxyclass:: simgrid::s4u::Io
1884
1885 Basic management
1886 ----------------
1887
1888 .. tabs::
1889
1890    .. group-tab:: C++
1891
1892       .. code-block:: C++
1893
1894          #include <simgrid/s4u/Io.hpp>
1895
1896       .. doxygentypedef:: IoPtr
1897
1898 Querying info
1899 -------------
1900
1901 .. tabs::
1902
1903    .. group-tab:: C++
1904
1905       .. autodoxymethod:: simgrid::s4u::Io::get_performed_ioops() const
1906       .. autodoxymethod:: simgrid::s4u::Io::get_remaining
1907
1908 Life cycle
1909 ----------
1910
1911 .. tabs::
1912
1913    .. group-tab:: C++
1914
1915       .. autodoxymethod:: simgrid::s4u::Io::cancel
1916       .. autodoxymethod:: simgrid::s4u::Io::start
1917       .. autodoxymethod:: simgrid::s4u::Io::test
1918       .. autodoxymethod:: simgrid::s4u::Io::wait
1919       .. autodoxymethod:: simgrid::s4u::Io::wait_for
1920
1921 .. _API_s4u_Synchronizations:
1922
1923 =======================
1924 Synchronization Objects
1925 =======================
1926
1927 .. _API_s4u_Mutex:
1928
1929 ==============
1930 ⁣  Mutex
1931 ==============
1932
1933 .. autodoxyclass:: simgrid::s4u::Mutex
1934
1935 Basic management
1936 ----------------
1937
1938    .. tabs::
1939
1940       .. group-tab:: C++
1941
1942          .. code-block:: C++
1943
1944             #include <simgrid/s4u/Mutex.hpp>
1945
1946          .. doxygentypedef:: MutexPtr
1947
1948          .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
1949          .. autodoxymethod:: simgrid::s4u::Mutex::create()
1950          .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
1951
1952       .. group-tab:: C
1953
1954          .. code-block:: C
1955
1956             #include <simgrid/mutex.h>
1957
1958          .. doxygentypedef:: sg_mutex_t
1959          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
1960
1961             Pointer to a constant mutex object.
1962
1963          .. autodoxymethod:: sg_mutex_init()
1964          .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
1965
1966 Locking
1967 -------
1968
1969    .. tabs::
1970
1971       .. group-tab:: C++
1972
1973          .. autodoxymethod:: simgrid::s4u::Mutex::lock()
1974          .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
1975          .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
1976
1977       .. group-tab:: C
1978
1979          .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
1980          .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
1981          .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
1982
1983 .. _API_s4u_Barrier:
1984
1985 ================
1986 ⁣  Barrier
1987 ================
1988
1989 .. autodoxyclass:: simgrid::s4u::Barrier
1990
1991    .. tabs::
1992
1993       .. group-tab:: C++
1994
1995          .. code-block:: C++
1996
1997             #include <simgrid/s4u/Barrier.hpp>
1998
1999          .. doxygentypedef:: BarrierPtr
2000
2001          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2002          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2003          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
2004
2005       .. group-tab:: C
2006
2007          .. code-block:: C
2008
2009             #include <simgrid/barrier.hpp>
2010
2011          .. doxygentypedef:: sg_bar_t
2012          .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2013
2014             Pointer to a constant barrier object.
2015
2016          .. autodoxymethod:: sg_barrier_init(unsigned int count)
2017          .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
2018          .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
2019
2020
2021 .. _API_s4u_ConditionVariable:
2022
2023 ==========================
2024 ⁣  Condition variable
2025 ==========================
2026
2027 .. autodoxyclass:: simgrid::s4u::ConditionVariable
2028
2029 Basic management
2030 ----------------
2031
2032    .. tabs::
2033
2034       .. group-tab:: C++
2035
2036          .. code-block:: C++
2037
2038             #include <simgrid/s4u/ConditionVariable.hpp>
2039
2040          .. doxygentypedef:: ConditionVariablePtr
2041
2042          .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
2043
2044       .. group-tab:: C
2045
2046          .. code-block:: C
2047
2048             #include <simgrid/cond.h>
2049
2050          .. doxygentypedef:: sg_cond_t
2051          .. autodoxymethod:: sg_cond_init
2052          .. autodoxymethod:: sg_cond_destroy
2053
2054 Waiting and notifying
2055 ---------------------
2056
2057    .. tabs::
2058
2059       .. group-tab:: C++
2060
2061          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
2062          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
2063          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2064          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2065          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2066          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2067          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2068          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2069          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2070          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2071          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2072          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2073          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2074
2075       .. group-tab:: C
2076
2077          .. autodoxymethod:: sg_cond_notify_all
2078          .. autodoxymethod:: sg_cond_notify_one
2079          .. autodoxymethod:: sg_cond_wait
2080          .. autodoxymethod:: sg_cond_wait_for
2081
2082 .. _API_s4u_Semaphore:
2083
2084 ==================
2085 ⁣  Semaphore
2086 ==================
2087
2088 .. autodoxyclass:: simgrid::s4u::Semaphore
2089
2090
2091 Basic management
2092 ----------------
2093
2094    .. tabs::
2095
2096       .. group-tab:: C++
2097
2098          .. code-block:: C++
2099
2100             #include <simgrid/s4u/Semaphore.hpp>
2101
2102          .. doxygentypedef:: SemaphorePtr
2103          .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
2104          .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
2105          .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2106
2107       .. group-tab:: C
2108
2109          .. code-block:: C
2110
2111             #include <simgrid/semaphore.h>
2112
2113          .. doxygentypedef:: sg_sem_t
2114          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2115
2116             Pointer to a constant semaphore object.
2117
2118          .. autodoxymethod:: sg_sem_init(int initial_value)
2119          .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
2120
2121 Locking
2122 -------
2123
2124    .. tabs::
2125
2126       .. group-tab:: C++
2127
2128          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
2129          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2130          .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity()
2131          .. autodoxymethod:: simgrid::s4u::Semaphore::release()
2132          .. autodoxymethod:: simgrid::s4u::Semaphore::would_block()
2133
2134       .. group-tab:: C
2135
2136          .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
2137          .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2138          .. autodoxymethod:: sg_sem_get_capacity(sg_sem_t sem)
2139          .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
2140          .. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)
2141
2142 .. |hr| raw:: html
2143
2144    <hr />