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