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