docs/source/app_s4u.rst

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