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       .. cpp:type:: const s4u_Actor* const_sg_actor_t
 442
 443          Pointer to a constant actor object.
 444
 445       .. doxygenfunction:: sg_actor_ref
 446       .. doxygenfunction:: sg_actor_unref
 447
 448
 449 Creating actors
 450 ---------------
 451
 452 .. tabs::
 453
 454    .. group-tab:: C++
 455
 456       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 457       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 458       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 459       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 460
 461       .. doxygenfunction:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 462       .. doxygenfunction:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 463
 464    .. group-tab:: Python
 465
 466       .. automethod:: simgrid.Actor.create
 467
 468    .. group-tab:: C
 469
 470       .. doxygenfunction:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, char *const *argv)
 471       .. doxygenfunction:: sg_actor_init(const char *name, sg_host_t host)
 472       .. doxygenfunction:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char *const *argv)
 473
 474       .. doxygenfunction:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 475       .. doxygenfunction:: sg_actor_detach()
 476
 477 Retrieving actors
 478 -----------------
 479
 480 .. tabs::
 481
 482    .. group-tab:: C++
 483
 484       .. doxygenfunction:: simgrid::s4u::Actor::by_pid(aid_t pid)
 485       .. doxygenfunction:: simgrid::s4u::Actor::self()
 486
 487    .. group-tab:: Python
 488
 489       .. automethod:: simgrid.Actor.by_pid
 490       .. automethod:: simgrid.Actor.self
 491
 492    .. group-tab:: C
 493
 494       .. doxygenfunction:: sg_actor_by_pid(aid_t pid)
 495       .. doxygenfunction:: sg_actor_self()
 496
 497 Querying info
 498 -------------
 499
 500 .. tabs::
 501
 502    .. group-tab:: C++
 503
 504       .. doxygenfunction:: simgrid::s4u::Actor::get_cname
 505       .. doxygenfunction:: simgrid::s4u::Actor::get_name
 506       .. doxygenfunction:: simgrid::s4u::Actor::get_pid
 507       .. doxygenfunction:: simgrid::s4u::Actor::get_ppid
 508       .. doxygenfunction:: simgrid::s4u::Actor::get_properties() const
 509       .. doxygenfunction:: simgrid::s4u::Actor::get_property(const std::string &key) const
 510       .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 511
 512       .. doxygenfunction:: simgrid::s4u::Actor::get_host
 513       .. doxygenfunction:: simgrid::s4u::Actor::set_host
 514
 515       .. doxygenfunction:: simgrid::s4u::Actor::get_refcount
 516       .. doxygenfunction:: simgrid::s4u::Actor::get_impl
 517
 518    .. group-tab:: Python
 519
 520       .. autoattribute:: simgrid.Actor.name
 521       .. autoattribute:: simgrid.Actor.host
 522       .. autoattribute:: simgrid.Actor.pid
 523       .. autoattribute:: simgrid.Actor.ppid
 524
 525    .. group-tab:: C
 526
 527       .. doxygenfunction:: sg_actor_get_name(const_sg_actor_t actor)
 528       .. doxygenfunction:: sg_actor_get_pid(const_sg_actor_t actor)
 529       .. doxygenfunction:: sg_actor_get_ppid(const_sg_actor_t actor)
 530       .. doxygenfunction:: sg_actor_get_properties(const_sg_actor_t actor)
 531       .. doxygenfunction:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 532
 533       .. doxygenfunction:: sg_actor_get_host(const_sg_actor_t actor)
 534       .. doxygenfunction:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 535
 536       .. doxygenfunction:: sg_actor_get_data(const_sg_actor_t actor)
 537       .. doxygenfunction:: sg_actor_set_data(sg_actor_t actor, void *userdata)
 538
 539 Suspending and resuming actors
 540 ------------------------------
 541
 542 .. tabs::
 543
 544    .. group-tab:: C++
 545
 546       .. doxygenfunction:: simgrid::s4u::Actor::suspend()
 547       .. doxygenfunction:: simgrid::s4u::Actor::resume()
 548       .. doxygenfunction:: simgrid::s4u::Actor::is_suspended
 549
 550    .. group-tab:: Python
 551
 552       .. automethod:: simgrid.Actor.resume
 553       .. automethod:: simgrid.Actor.suspend
 554       .. automethod:: simgrid.Actor.is_suspended
 555
 556    .. group-tab:: C
 557
 558       .. doxygenfunction:: sg_actor_suspend(sg_actor_t actor)
 559       .. doxygenfunction:: sg_actor_resume(sg_actor_t actor)
 560       .. doxygenfunction:: sg_actor_is_suspended(const_sg_actor_t actor)
 561
 562 Specifying when actors should terminate
 563 ---------------------------------------
 564
 565 .. tabs::
 566
 567    .. group-tab:: C++
 568
 569       .. doxygenfunction:: simgrid::s4u::Actor::kill()
 570       .. doxygenfunction:: simgrid::s4u::Actor::kill_all()
 571       .. doxygenfunction:: simgrid::s4u::Actor::set_kill_time(double time)
 572       .. doxygenfunction:: simgrid::s4u::Actor::get_kill_time
 573
 574       .. doxygenfunction:: simgrid::s4u::Actor::restart()
 575       .. doxygenfunction:: simgrid::s4u::Actor::daemonize()
 576       .. doxygenfunction:: simgrid::s4u::Actor::is_daemon
 577
 578    .. group-tab:: Python
 579
 580       .. automethod:: simgrid.Actor.kill
 581       .. automethod:: simgrid.Actor.kill_all
 582
 583       .. automethod:: simgrid.Actor.daemonize
 584       .. automethod:: simgrid.Actor.is_daemon
 585
 586    .. group-tab:: C
 587
 588       .. doxygenfunction:: sg_actor_kill(sg_actor_t actor)
 589       .. doxygenfunction:: sg_actor_kill_all()
 590       .. doxygenfunction:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 591
 592       .. doxygenfunction:: sg_actor_restart(sg_actor_t actor)
 593       .. doxygenfunction:: sg_actor_daemonize(sg_actor_t actor)
 594       .. doxygenfunction:: sg_actor_is_daemon
 595
 596 .. _API_s4u_Actor_end:
 597
 598 Reacting to the end of actors
 599 -----------------------------
 600
 601 .. tabs::
 602
 603    .. group-tab:: C++
 604
 605       .. doxygenfunction:: simgrid::s4u::Actor::on_exit
 606       .. doxygenfunction:: simgrid::s4u::Actor::join() const
 607       .. doxygenfunction:: simgrid::s4u::Actor::join(double timeout) const
 608       .. doxygenfunction:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 609
 610    .. group-tab:: Python
 611
 612       .. automethod:: simgrid.Actor.join
 613
 614    .. group-tab:: C
 615
 616       .. doxygenfunction:: sg_actor_on_exit
 617       .. doxygenfunction:: sg_actor_join(const_sg_actor_t actor, double timeout)
 618       .. doxygenfunction:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 619
 620 Signals
 621 -------
 622
 623 .. tabs::
 624
 625    .. group-tab:: C++
 626
 627       .. doxygenvariable:: simgrid::s4u::Actor::on_creation
 628       .. doxygenvariable:: simgrid::s4u::Actor::on_suspend
 629       .. doxygenvariable:: simgrid::s4u::Actor::on_host_change
 630       .. doxygenvariable:: simgrid::s4u::Actor::on_resume
 631       .. doxygenvariable:: simgrid::s4u::Actor::on_sleep
 632       .. doxygenvariable:: simgrid::s4u::Actor::on_wake_up
 633       .. doxygenvariable:: simgrid::s4u::Actor::on_termination
 634       .. doxygenvariable:: simgrid::s4u::Actor::on_destruction
 635
 636 .. _API_s4u_this_actor:
 637
 638 ====================
 639 ⁣  The current actor
 640 ====================
 641
 642 These functions can be used in your user code to interact with the actor
 643 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 644 Using these functions can greatly improve the code readability.
 645
 646 Querying info
 647 -------------
 648
 649 .. tabs::
 650
 651    .. group-tab:: C++
 652
 653       .. doxygenfunction:: simgrid::s4u::this_actor::get_cname()
 654       .. doxygenfunction:: simgrid::s4u::this_actor::get_name()
 655       .. doxygenfunction:: simgrid::s4u::this_actor::get_pid()
 656       .. doxygenfunction:: simgrid::s4u::this_actor::get_ppid()
 657       .. doxygenfunction:: simgrid::s4u::this_actor::is_maestro()
 658
 659       .. doxygenfunction:: simgrid::s4u::this_actor::get_host()
 660       .. doxygenfunction:: simgrid::s4u::this_actor::set_host(Host *new_host)
 661
 662    .. group-tab:: Python
 663
 664       .. autofunction:: simgrid.this_actor.get_host
 665       .. autofunction:: simgrid.this_actor.set_host
 666
 667    .. group-tab:: C
 668
 669       .. doxygenfunction:: sg_actor_self_get_data()
 670       .. doxygenfunction:: sg_actor_self_set_data(void *data)
 671       .. doxygenfunction:: sg_actor_self_get_name()
 672       .. doxygenfunction:: sg_actor_self_get_pid()
 673       .. doxygenfunction:: sg_actor_self_get_ppid()
 674       .. doxygenfunction:: sg_host_self()
 675       .. doxygenfunction:: sg_host_self_get_name()
 676
 677 Suspending and resuming
 678 -----------------------
 679
 680 .. tabs::
 681
 682    .. group-tab:: C++
 683
 684       .. doxygenfunction:: simgrid::s4u::this_actor::suspend()
 685       .. doxygenfunction:: simgrid::s4u::this_actor::yield()
 686
 687    .. group-tab:: Python
 688
 689       .. autofunction:: simgrid.this_actor.suspend
 690       .. autofunction:: simgrid.this_actor.yield_
 691
 692    .. group-tab:: C
 693
 694       .. doxygenfunction:: sg_actor_yield()
 695
 696 Logging messages
 697 ----------------
 698
 699 .. tabs::
 700
 701    .. group-tab:: Python
 702
 703        .. autofunction:: simgrid.this_actor.info
 704        .. autofunction:: simgrid.this_actor.error
 705
 706 Sleeping
 707 --------
 708
 709 .. tabs::
 710
 711    .. group-tab:: C++
 712
 713       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(double duration)
 714       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
 715       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
 716       .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
 717
 718    .. group-tab:: Python
 719
 720       .. autofunction:: simgrid.this_actor.sleep_for
 721       .. autofunction:: simgrid.this_actor.sleep_until
 722
 723    .. group-tab:: C
 724
 725       .. doxygenfunction:: sg_actor_sleep_for(double duration)
 726
 727 Simulating executions
 728 ---------------------
 729
 730 Simulate the execution of some code on this actor. You can either simulate
 731 parallel or sequential code and you can either block upon the termination of
 732 the execution, or start an asynchronous activity.
 733
 734 .. tabs::
 735
 736    .. group-tab:: C++
 737
 738       .. doxygenfunction:: simgrid::s4u::this_actor::exec_async
 739       .. 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)
 740       .. doxygenfunction:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
 741       .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop)
 742       .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop, double priority)
 743       .. 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)
 744       .. 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, double timeout)
 745
 746    .. group-tab:: Python
 747
 748       .. autofunction:: simgrid.this_actor.exec_init
 749       .. autofunction:: simgrid.this_actor.execute
 750
 751    .. group-tab:: C
 752
 753       .. doxygenfunction:: sg_actor_execute(double flops)
 754       .. doxygenfunction:: sg_actor_execute_with_priority(double flops, double priority)
 755       .. doxygenfunction:: sg_actor_exec_init(double computation_amount)
 756       .. doxygenfunction:: sg_actor_exec_async(double computation_amount)
 757       .. doxygenfunction:: sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount, double* bytes_amount);
 758
 759 Exiting
 760 -------
 761
 762 .. tabs::
 763
 764    .. group-tab:: C++
 765
 766       .. doxygenfunction:: simgrid::s4u::this_actor::exit()
 767       .. doxygenfunction:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 768
 769    .. group-tab:: Python
 770
 771       .. autofunction:: simgrid.this_actor.exit
 772       .. autofunction:: simgrid.this_actor.on_exit
 773
 774    .. group-tab:: c
 775
 776       See also :cpp:func:`sg_actor_on_exit`.
 777
 778       .. doxygenfunction:: sg_actor_exit
 779
 780 .. _API_s4u_Engine:
 781
 782 ====================
 783 ⁣  Simulation Engine
 784 ====================
 785
 786 .. doxygenclass:: simgrid::s4u::Engine
 787
 788 Initialization
 789 --------------
 790
 791 .. tabs::
 792
 793    .. group-tab:: C++
 794
 795       .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 796       .. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
 797       .. doxygenfunction:: simgrid::s4u::Engine::shutdown()
 798       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
 799       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
 800       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
 801       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
 802       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
 803
 804       .. doxygenfunction:: simgrid::s4u::Engine::load_deployment
 805       .. doxygenfunction:: simgrid::s4u::Engine::load_platform
 806       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name)
 807       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 808       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
 809       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
 810
 811       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
 812       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
 813       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
 814
 815    .. group-tab:: Python
 816
 817        .. automethod:: simgrid.Engine.load_deployment
 818        .. automethod:: simgrid.Engine.load_platform
 819        .. automethod:: simgrid.Engine.register_actor
 820
 821    .. group-tab:: C
 822
 823       .. doxygenfunction:: simgrid_init
 824
 825       .. doxygenfunction:: simgrid_load_deployment
 826       .. doxygenfunction:: simgrid_load_platform
 827       .. doxygenfunction:: simgrid_register_default
 828       .. doxygenfunction:: simgrid_register_function
 829
 830 Run the simulation
 831 ------------------
 832
 833 .. tabs::
 834
 835    .. group-tab:: C++
 836
 837       .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
 838       .. doxygenfunction:: simgrid::s4u::Engine::run
 839
 840    .. group-tab:: Python
 841
 842       .. automethod:: simgrid.Engine.get_clock
 843       .. automethod:: simgrid.Engine.run
 844
 845    .. group-tab:: C
 846
 847       .. doxygenfunction:: simgrid_get_clock
 848       .. doxygenfunction:: simgrid_run
 849
 850 Retrieving actors
 851 -----------------
 852
 853 .. tabs::
 854
 855    .. group-tab:: C++
 856
 857       .. doxygenfunction:: simgrid::s4u::Engine::get_actor_count
 858       .. doxygenfunction:: simgrid::s4u::Engine::get_all_actors
 859       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_actors
 860
 861    .. group-tab:: C
 862
 863       .. doxygenfunction:: simgrid_get_actor_count()
 864
 865 Retrieving hosts
 866 ----------------
 867
 868 .. tabs::
 869
 870    .. group-tab:: C++
 871
 872       .. doxygenfunction:: simgrid::s4u::Engine::get_all_hosts
 873       .. doxygenfunction:: simgrid::s4u::Engine::get_host_count
 874       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_hosts
 875       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name
 876       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name_or_null
 877
 878    .. group-tab:: Python
 879
 880       .. automethod:: simgrid.Engine.get_all_hosts
 881
 882    .. group-tab:: C
 883
 884       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 885
 886 Retrieving links
 887 ----------------
 888
 889 .. tabs::
 890
 891    .. group-tab:: C++
 892
 893       .. doxygenfunction:: simgrid::s4u::Engine::get_all_links
 894       .. doxygenfunction:: simgrid::s4u::Engine::get_link_count
 895       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_links
 896       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name
 897       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name_or_null
 898
 899 Interacting with the routing
 900 ----------------------------
 901
 902 .. tabs::
 903
 904    .. group-tab:: C++
 905
 906       .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
 907       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
 908       .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
 909       .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
 910       .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
 911       .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
 912       .. doxygenfunction:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 913
 914 Signals
 915 -------
 916
 917 .. tabs::
 918
 919    .. group-tab:: C++
 920
 921       .. doxygenvariable:: simgrid::s4u::Engine::on_deadlock
 922       .. doxygenvariable:: simgrid::s4u::Engine::on_platform_created
 923       .. doxygenvariable:: simgrid::s4u::Engine::on_platform_creation
 924       .. doxygenvariable:: simgrid::s4u::Engine::on_simulation_end
 925       .. doxygenvariable:: simgrid::s4u::Engine::on_time_advance
 926
 927 .. _API_s4u_Mailbox:
 928
 929 ================
 930 ⁣  class Mailbox
 931 ================
 932
 933 .. doxygenclass:: simgrid::s4u::Mailbox
 934
 935 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 936
 937 Basic management
 938 ----------------
 939
 940 .. tabs::
 941
 942    .. group-tab:: C++
 943
 944       .. code-block:: C++
 945
 946          #include <simgrid/s4u/Mailbox.hpp>
 947
 948       Note that there is no MailboxPtr type and that you cannot use the RAII
 949       idiom on mailboxes because they are internal objects to the simulation
 950       engine. Once created, there is no way to destroy a mailbox before the end
 951       of the simulation.
 952
 953       .. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
 954
 955    .. group-tab:: Python
 956
 957       .. code-block:: C++
 958
 959          #include <simgrid/mailbox.h>
 960
 961       .. autoclass:: simgrid.Mailbox
 962
 963       .. automethod:: simgrid.Mailbox.by_name
 964
 965    .. group-tab:: C
 966
 967       .. code-block:: C
 968
 969          #include <simgrid/s4u/mailbox.h>
 970
 971       .. doxygentypedef:: sg_mailbox_t
 972       .. doxygentypedef:: const_sg_mailbox_t
 973
 974       .. doxygenfunction:: sg_mailbox_by_name(const char *alias)
 975
 976 Querying info
 977 -------------
 978
 979 .. tabs::
 980
 981    .. group-tab:: C++
 982
 983       .. doxygenfunction:: simgrid::s4u::Mailbox::get_cname
 984       .. doxygenfunction:: simgrid::s4u::Mailbox::get_name
 985
 986    .. group-tab:: Python
 987
 988       .. autoattribute:: simgrid.Mailbox.name
 989
 990 Sending data
 991 ------------
 992
 993 .. tabs::
 994
 995    .. group-tab:: C++
 996
 997       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
 998       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
 999       .. doxygenfunction:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
1000       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init()
1001       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
1002
1003    .. group-tab:: Python
1004
1005       .. automethod:: simgrid.Mailbox.put
1006       .. automethod:: simgrid.Mailbox.put_async
1007
1008    .. group-tab: C
1009
1010       .. doxygenfunction:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1011       .. doxygenfunction:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1012       .. doxygenfunction:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1013
1014
1015 Receiving data
1016 --------------
1017
1018 .. tabs::
1019
1020    .. group-tab:: C++
1021
1022       .. doxygenfunction:: simgrid::s4u::Mailbox::empty
1023       .. doxygenfunction:: simgrid::s4u::Mailbox::front
1024       .. doxygenfunction:: simgrid::s4u::Mailbox::get()
1025       .. doxygenfunction:: simgrid::s4u::Mailbox::get(double timeout)
1026       .. doxygenfunction:: simgrid::s4u::Mailbox::get_async(T **data)
1027       .. doxygenfunction:: simgrid::s4u::Mailbox::get_init()
1028       .. doxygenfunction:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
1029       .. doxygenfunction:: simgrid::s4u::Mailbox::listen
1030       .. doxygenfunction:: simgrid::s4u::Mailbox::ready
1031
1032    .. group-tab:: Python
1033
1034        .. automethod:: simgrid.Mailbox.get
1035
1036    .. group-tab:: C
1037
1038       .. doxygenfunction:: sg_mailbox_get(sg_mailbox_t mailbox)
1039       .. doxygenfunction:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1040       .. doxygenfunction:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1041       .. doxygenfunction:: sg_mailbox_listen(const char *alias)
1042
1043 Receiving actor
1044 ---------------
1045
1046 See :ref:`s4u_receiving_actor`.
1047
1048 .. tabs::
1049
1050    .. group-tab:: C++
1051
1052       .. doxygenfunction:: simgrid::s4u::Mailbox::get_receiver
1053       .. doxygenfunction:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1054
1055    .. group-tab:: C
1056
1057       .. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
1058
1059 .. _API_s4u_Resource:
1060
1061 =========
1062 Resources
1063 =========
1064
1065 .. _API_s4u_Disk:
1066
1067 =============
1068 ⁣  class Disk
1069 =============
1070
1071 .. doxygenclass:: simgrid::s4u::Disk
1072
1073 Basic management
1074 ----------------
1075
1076 .. tabs::
1077
1078    .. group-tab:: C++
1079
1080       .. code-block:: C++
1081
1082          #include <simgrid/s4u/Disk.hpp>
1083
1084       Note that there is no DiskPtr type and that you cannot use the RAII
1085       idiom on disks because SimGrid does not allow (yet) to create nor
1086       destroy resources once the simulation is started.
1087
1088
1089 Querying info
1090 -------------
1091
1092 .. tabs::
1093
1094    .. group-tab:: C++
1095
1096       .. doxygenfunction:: simgrid::s4u::Disk::get_cname() const
1097       .. doxygenfunction:: simgrid::s4u::Disk::get_host() const
1098       .. doxygenfunction:: simgrid::s4u::Disk::get_name() const
1099       .. doxygenfunction:: simgrid::s4u::Disk::get_properties() const
1100       .. doxygenfunction:: simgrid::s4u::Disk::get_property(const std::string &key) const
1101       .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
1102       .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
1103       .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1104
1105 I/O operations
1106 --------------
1107
1108 .. tabs::
1109
1110    .. group-tab:: C++
1111
1112       .. doxygenfunction:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type) const
1113       .. doxygenfunction:: simgrid::s4u::Disk::read(sg_size_t size) const
1114       .. doxygenfunction:: simgrid::s4u::Disk::read_async(sg_size_t size) const
1115       .. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
1116       .. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
1117
1118 Signals
1119 -------
1120
1121 .. tabs::
1122
1123    .. group-tab:: C++
1124
1125       .. doxygenvariable:: simgrid::s4u::Disk::on_creation
1126       .. doxygenvariable:: simgrid::s4u::Disk::on_destruction
1127       .. doxygenvariable:: simgrid::s4u::Disk::on_state_change
1128
1129
1130 .. _API_s4u_Host:
1131
1132 =============
1133 ⁣  class Host
1134 =============
1135
1136 .. doxygenclass:: simgrid::s4u::Host
1137
1138 Basic management
1139 ----------------
1140
1141 .. tabs::
1142
1143    .. group-tab:: C++
1144
1145       .. code-block:: C++
1146
1147          #include <simgrid/s4u/Host.hpp>
1148
1149       Note that there is no HostPtr type, and that you cannot use the RAII
1150       idiom on hosts because SimGrid does not allow (yet) to create nor
1151       destroy resources once the simulation is started.
1152
1153       .. doxygenfunction:: simgrid::s4u::Host::destroy()
1154
1155    .. group-tab:: Python
1156
1157       .. code:: Python
1158
1159          from simgrid import Host
1160
1161    .. group-tab:: C
1162
1163       .. code:: C
1164
1165          #include <simgrid/host.h>
1166
1167       .. doxygentypedef:: sg_host_t
1168       .. cpp:type:: const s4u_Host* const_sg_host_t
1169
1170          Pointer to a constant host object.
1171
1172 Retrieving hosts
1173 ----------------
1174
1175 .. tabs::
1176
1177    .. group-tab:: C++
1178
1179       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1180
1181       .. doxygenfunction:: simgrid::s4u::Host::by_name(const std::string &name)
1182       .. doxygenfunction:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1183       .. doxygenfunction:: simgrid::s4u::Host::current()
1184
1185    .. group-tab:: Python
1186
1187       See also :py:func:`simgrid.Engine.get_all_hosts`.
1188
1189       .. automethod:: simgrid.Host.by_name
1190       .. automethod:: simgrid.Host.current
1191
1192    .. group-tab:: C
1193
1194       .. doxygenfunction:: sg_host_by_name(const char *name)
1195       .. doxygenfunction:: sg_host_count()
1196       .. doxygenfunction:: sg_host_list()
1197       .. doxygenfunction:: sg_hosts_as_dynar()
1198
1199 Querying info
1200 -------------
1201
1202 .. tabs::
1203
1204    .. group-tab:: C++
1205
1206       .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1207       .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1208       .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1209       .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1210       .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1211       .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1212
1213    .. group-tab:: Python
1214
1215       .. autoattribute:: simgrid.Host.name
1216       .. autoattribute:: simgrid.Host.load
1217       .. autoattribute:: simgrid.Host.pstate
1218       .. autoattribute:: simgrid.Host.speed
1219
1220    .. group-tab:: C
1221
1222       .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1223       .. doxygenfunction:: sg_host_dump(const_sg_host_t ws)
1224       .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1225       .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1226       .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1227
1228 User data and properties
1229 ------------------------
1230
1231 .. tabs::
1232
1233    .. group-tab:: C++
1234
1235       .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1236       .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1237       .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1238       .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1239
1240    .. group-tab:: C
1241
1242       .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1243       .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1244       .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1245       .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1246       .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1247
1248 Retrieving components
1249 ---------------------
1250
1251 .. tabs::
1252
1253    .. group-tab:: C++
1254
1255       .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1256       .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1257       .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1258       .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1259       .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1260
1261    .. group-tab:: C
1262
1263       .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1264
1265 On/Off
1266 ------
1267
1268 .. tabs::
1269
1270    .. group-tab:: C++
1271
1272       .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1273       .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1274       .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1275
1276    .. group-tab:: C
1277
1278       .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1279       .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1280       .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1281
1282 DVFS
1283 ----
1284
1285 .. tabs::
1286
1287    .. group-tab:: C++
1288
1289       .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1290       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1291       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
1292       .. doxygenfunction:: simgrid::s4u::Host::set_pstate(int pstate_index)
1293       .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1294       .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1295
1296    .. group-tab:: Python
1297
1298       .. automethod:: simgrid.Host.get_pstate_count
1299       .. automethod:: simgrid.Host.get_pstate_speed
1300
1301    .. group-tab:: C
1302
1303       .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1304       .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1305       .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1306       .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1307       .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, int pstate)
1308
1309 Execution
1310 ---------
1311
1312 .. tabs::
1313
1314    .. group-tab:: C++
1315
1316       .. doxygenfunction:: simgrid::s4u::Host::exec_async
1317       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1318       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1319
1320 Platform and routing
1321 --------------------
1322
1323 You can also start direct communications between two arbitrary hosts
1324 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1325
1326 .. tabs::
1327
1328    .. group-tab:: C++
1329
1330       .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1331       .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1332       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1333       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
1334
1335    .. group-tab:: C
1336
1337       .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1338       .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1339       .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1340       .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1341
1342 Signals
1343 -------
1344
1345 .. tabs::
1346
1347    .. group-tab:: C++
1348
1349       .. doxygenvariable:: simgrid::s4u::Host::on_creation
1350       .. doxygenvariable:: simgrid::s4u::Host::on_destruction
1351       .. doxygenvariable:: simgrid::s4u::Host::on_speed_change
1352       .. doxygenvariable:: simgrid::s4u::Host::on_state_change
1353
1354 .. _API_s4u_Link:
1355
1356 =============
1357 ⁣  class Link
1358 =============
1359
1360 .. doxygenclass:: simgrid::s4u::Link
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_bypass_route
1615       .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1616       .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1617       .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1618       .. doxygenfunction:: simgrid::s4u::NetZone::get_father()
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_route_creation
1633      .. doxygenvariable:: simgrid::s4u::NetZone::on_seal
1634
1635 .. _API_s4u_VirtualMachine:
1636
1637 =======================
1638 ⁣  class VirtualMachine
1639 =======================
1640
1641
1642 .. doxygenclass:: simgrid::s4u::VirtualMachine
1643
1644 Basic management
1645 ----------------
1646 .. tabs::
1647
1648    .. group-tab:: C++
1649
1650       .. code-block:: C++
1651
1652          #include <simgrid/s4u/VirtualMachine.hpp>
1653
1654       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1655       idiom on virtual machines. There is no good reason for that and should change in the future.
1656
1657    .. group-tab:: C
1658
1659       .. code:: C
1660
1661          #include <simgrid/vm.h>
1662
1663       .. doxygentypedef:: sg_vm_t
1664       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1665
1666          Pointer to a constant virtual machine object.
1667
1668 Creating VMs
1669 ------------
1670
1671 .. tabs::
1672
1673    .. group-tab:: C++
1674
1675       .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1676       .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1677       .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1678
1679    .. group-tab:: C
1680
1681       .. doxygenfunction:: sg_vm_create_core
1682       .. doxygenfunction:: sg_vm_create_multicore
1683       .. doxygenfunction:: sg_vm_destroy
1684
1685 Querying info
1686 --------------
1687
1688 .. tabs::
1689
1690    .. group-tab:: C++
1691
1692       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1693       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
1694       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
1695
1696       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1697       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1698       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1699
1700    .. group-tab:: C
1701
1702       .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
1703       .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
1704       .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1705
1706       .. doxygenfunction:: sg_vm_get_name
1707       .. doxygenfunction:: sg_vm_get_pm
1708       .. doxygenfunction:: sg_vm_is_created
1709       .. doxygenfunction:: sg_vm_is_running
1710       .. doxygenfunction:: sg_vm_is_suspended
1711
1712 Life cycle
1713 ----------
1714
1715 .. tabs::
1716
1717    .. group-tab:: C++
1718
1719       .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
1720       .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
1721       .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
1722       .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
1723
1724    .. group-tab:: C
1725
1726       .. doxygenfunction:: sg_vm_start
1727       .. doxygenfunction:: sg_vm_suspend
1728       .. doxygenfunction:: sg_vm_resume
1729       .. doxygenfunction:: sg_vm_shutdown
1730
1731 Signals
1732 -------
1733
1734 .. tabs::
1735
1736    .. group-tab:: C++
1737
1738       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_end
1739       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_start
1740       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_resume
1741       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_shutdown
1742       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_start
1743       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_started
1744       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_suspend
1745
1746 .. _API_s4u_Activity:
1747
1748 ==============
1749 class Activity
1750 ==============
1751
1752 .. doxygenclass:: simgrid::s4u::Activity
1753
1754 **Known subclasses:**
1755 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1756 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1757 :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1758 See also the :ref:`section on activities <s4u_Activities>` above.
1759
1760 Basic management
1761 ----------------
1762
1763 .. tabs::
1764
1765    .. group-tab:: C++
1766
1767       .. code-block:: C++
1768
1769          #include <simgrid/s4u/Activity.hpp>
1770
1771       .. doxygentypedef:: ActivityPtr
1772
1773 Querying info
1774 -------------
1775
1776 .. tabs::
1777
1778    .. group-tab:: C++
1779
1780       .. doxygenfunction:: simgrid::s4u::Activity::get_cname
1781       .. doxygenfunction:: simgrid::s4u::Activity::get_name
1782       .. doxygenfunction:: simgrid::s4u::Activity::get_remaining() const
1783       .. doxygenfunction:: simgrid::s4u::Activity::get_state() const
1784       .. doxygenfunction:: simgrid::s4u::Activity::set_remaining(double remains)
1785       .. doxygenfunction:: simgrid::s4u::Activity::set_state(Activity::State state)
1786
1787
1788 Activities life cycle
1789 ---------------------
1790
1791 .. tabs::
1792
1793    .. group-tab:: C++
1794
1795       .. doxygenfunction:: simgrid::s4u::Activity::start
1796       .. doxygenfunction:: simgrid::s4u::Activity::cancel
1797       .. doxygenfunction:: simgrid::s4u::Activity::test
1798       .. doxygenfunction:: simgrid::s4u::Activity::wait
1799       .. doxygenfunction:: simgrid::s4u::Activity::wait_for
1800       .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit)
1801       .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start()
1802
1803 Suspending and resuming an activity
1804 -----------------------------------
1805
1806 .. tabs::
1807
1808    .. group-tab:: C++
1809
1810       .. doxygenfunction:: simgrid::s4u::Activity::suspend
1811       .. doxygenfunction:: simgrid::s4u::Activity::resume
1812       .. doxygenfunction:: simgrid::s4u::Activity::is_suspended
1813
1814 .. _API_s4u_Comm:
1815
1816 =============
1817 ⁣  class Comm
1818 =============
1819
1820 .. doxygenclass:: simgrid::s4u::Comm
1821
1822 Basic management
1823 ----------------
1824
1825 .. tabs::
1826
1827    .. group-tab:: C++
1828
1829       .. code-block:: C++
1830
1831          #include <simgrid/s4u/Comm.hpp>
1832
1833       .. doxygentypedef:: CommPtr
1834
1835    .. group-tab:: Python
1836
1837       .. code:: Python
1838
1839          from simgrid import Comm
1840
1841       .. autoclass:: simgrid.Comm
1842
1843    .. group-tab:: c
1844
1845       .. code:: c
1846
1847          #include <simgrid/comm.h>
1848
1849       .. doxygentypedef:: sg_comm_t
1850       .. doxygentypedef:: const_sg_comm_t
1851
1852 Querying info
1853 -------------
1854
1855 .. tabs::
1856
1857    .. group-tab:: C++
1858
1859       .. doxygenfunction:: simgrid::s4u::Comm::get_dst_data_size() const
1860       .. doxygenfunction:: simgrid::s4u::Comm::get_mailbox() const
1861       .. doxygenfunction:: simgrid::s4u::Comm::get_sender() const
1862       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff)
1863       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
1864       .. doxygenfunction:: simgrid::s4u::Comm::detach()
1865       .. doxygenfunction:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
1866       .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(double bytes)
1867       .. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
1868       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
1869       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
1870       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data_size(size_t size)
1871
1872 Life cycle
1873 ----------
1874
1875 Most communications are created using :ref:`s4u_mailbox`, but you can
1876 also start direct communications as shown below.
1877
1878 .. tabs::
1879
1880    .. group-tab:: C++
1881
1882       .. doxygenfunction:: simgrid::s4u::Comm::sendto
1883       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init
1884       .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
1885
1886       .. doxygenfunction:: simgrid::s4u::Comm::cancel
1887       .. doxygenfunction:: simgrid::s4u::Comm::start
1888       .. doxygenfunction:: simgrid::s4u::Comm::test
1889       .. doxygenfunction:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr >& comms)
1890       .. doxygenfunction:: simgrid::s4u::Comm::wait
1891       .. doxygenfunction:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr >& comms)
1892       .. doxygenfunction:: simgrid::s4u::Comm::wait_all_for(const std::vector< CommPtr >& comms, double timeout)
1893       .. doxygenfunction:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr >& comms)
1894       .. doxygenfunction:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr >& comms, double timeout)
1895       .. doxygenfunction:: simgrid::s4u::Comm::wait_for
1896
1897    .. group-tab:: Python
1898
1899        .. automethod:: simgrid.Comm.test
1900        .. automethod:: simgrid.Comm.wait
1901        .. automethod:: simgrid.Comm.wait_all
1902        .. automethod:: simgrid.Comm.wait_any
1903
1904 Signals
1905 -------
1906
1907 .. tabs::
1908
1909    .. group-tab:: C++
1910
1911       .. doxygenvariable:: simgrid::s4u::Comm::on_completion
1912       .. doxygenvariable:: simgrid::s4u::Comm::on_start
1913
1914 .. _API_s4u_Exec:
1915
1916 =============
1917 ⁣  class Exec
1918 =============
1919
1920 .. doxygenclass:: simgrid::s4u::Exec
1921
1922 Basic management
1923 ----------------
1924
1925 .. tabs::
1926
1927    .. group-tab:: C++
1928
1929       .. code-block:: C++
1930
1931          #include <simgrid/s4u/Exec.hpp>
1932
1933       .. doxygentypedef:: ExecPtr
1934
1935    .. group-tab:: Python
1936
1937       .. code:: Python
1938
1939          from simgrid import Exec
1940
1941       .. autoclass:: simgrid.Exec
1942
1943    .. group-tab:: C
1944
1945       .. code-block:: C
1946
1947          #include <simgrid/exec.h>
1948
1949       .. doxygentypedef:: sg_exec_t
1950       .. doxygentypedef:: const_sg_exec_t
1951
1952 Querying info
1953 -------------
1954
1955 .. tabs::
1956
1957    .. group-tab:: C++
1958
1959       .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
1960       .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
1961       .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
1962       .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
1963       .. cpp:function:: double Exec::get_remaining()
1964
1965          On sequential executions, returns the amount of flops that remain to be done;
1966          This cannot be used on parallel executions.
1967
1968       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
1969       .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
1970       .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
1971       .. doxygenfunction:: simgrid::s4u::Exec::set_host
1972       .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
1973
1974    .. group-tab:: Python
1975
1976       .. autoattribute:: simgrid.Exec.host
1977       .. autoattribute:: simgrid.Exec.remaining
1978       .. autoattribute:: simgrid.Exec.remaining_ratio
1979
1980    .. group-tab:: C
1981
1982       .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
1983       .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
1984       .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
1985       .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
1986       .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
1987       .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
1988
1989 Life cycle
1990 ----------
1991
1992 .. tabs::
1993
1994    .. group-tab:: C++
1995
1996       .. doxygenfunction:: simgrid::s4u::Exec::cancel
1997       .. doxygenfunction:: simgrid::s4u::Exec::set_timeout(double timeout)
1998       .. doxygenfunction:: simgrid::s4u::Exec::start
1999       .. doxygenfunction:: simgrid::s4u::Exec::test
2000       .. doxygenfunction:: simgrid::s4u::Exec::wait
2001       .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2002       .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2003       .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2004
2005    .. group-tab:: Python
2006
2007        .. automethod:: simgrid.Exec.cancel
2008        .. automethod:: simgrid.Exec.start
2009        .. automethod:: simgrid.Exec.test
2010        .. automethod:: simgrid.Exec.wait
2011
2012    .. group-tab:: C
2013
2014        .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2015        .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2016        .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2017        .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2018        .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2019        .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2020        .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2021
2022 Signals
2023 -------
2024
2025 .. tabs::
2026
2027    .. group-tab:: C++
2028
2029       .. doxygenvariable:: simgrid::s4u::Exec::on_start
2030       .. doxygenvariable:: simgrid::s4u::Exec::on_completion
2031
2032 .. _API_s4u_Io:
2033
2034 ===========
2035 ⁣  class Io
2036 ===========
2037
2038 .. doxygenclass:: simgrid::s4u::Io
2039
2040 Basic management
2041 ----------------
2042
2043 .. tabs::
2044
2045    .. group-tab:: C++
2046
2047       .. code-block:: C++
2048
2049          #include <simgrid/s4u/Io.hpp>
2050
2051       .. doxygentypedef:: IoPtr
2052
2053 Querying info
2054 -------------
2055
2056 .. tabs::
2057
2058    .. group-tab:: C++
2059
2060       .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2061       .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2062
2063 Life cycle
2064 ----------
2065
2066 .. tabs::
2067
2068    .. group-tab:: C++
2069
2070       .. doxygenfunction:: simgrid::s4u::Io::cancel
2071       .. doxygenfunction:: simgrid::s4u::Io::start
2072       .. doxygenfunction:: simgrid::s4u::Io::test
2073       .. doxygenfunction:: simgrid::s4u::Io::wait
2074       .. doxygenfunction:: simgrid::s4u::Io::wait_for
2075
2076 .. _API_s4u_Synchronizations:
2077
2078 =======================
2079 Synchronization Objects
2080 =======================
2081
2082 .. _API_s4u_Mutex:
2083
2084 ==============
2085 ⁣  Mutex
2086 ==============
2087
2088 .. doxygenclass:: simgrid::s4u::Mutex
2089
2090 Basic management
2091 ----------------
2092
2093    .. tabs::
2094
2095       .. group-tab:: C++
2096
2097          .. code-block:: C++
2098
2099             #include <simgrid/s4u/Mutex.hpp>
2100
2101          .. doxygentypedef:: MutexPtr
2102
2103          .. doxygenfunction:: simgrid::s4u::Mutex::create()
2104
2105       .. group-tab:: C
2106
2107          .. code-block:: C
2108
2109             #include <simgrid/mutex.h>
2110
2111          .. doxygentypedef:: sg_mutex_t
2112          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2113
2114             Pointer to a constant mutex object.
2115
2116          .. doxygenfunction:: sg_mutex_init()
2117          .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2118
2119 Locking
2120 -------
2121
2122    .. tabs::
2123
2124       .. group-tab:: C++
2125
2126          .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2127          .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2128          .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2129
2130       .. group-tab:: C
2131
2132          .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2133          .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2134          .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2135
2136 .. _API_s4u_Barrier:
2137
2138 ================
2139 ⁣  Barrier
2140 ================
2141
2142 .. doxygenclass:: simgrid::s4u::Barrier
2143
2144 .. tabs::
2145
2146    .. group-tab:: C++
2147
2148       .. code-block:: C++
2149
2150          #include <simgrid/s4u/Barrier.hpp>
2151
2152       .. doxygentypedef:: BarrierPtr
2153
2154       .. doxygenfunction:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2155       .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2156       .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2157
2158    .. group-tab:: C
2159
2160       .. code-block:: C
2161
2162          #include <simgrid/barrier.hpp>
2163
2164       .. doxygentypedef:: sg_bar_t
2165       .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2166
2167          Pointer to a constant barrier object.
2168
2169       .. doxygenfunction:: sg_barrier_init(unsigned int count)
2170       .. doxygenfunction:: sg_barrier_destroy(const_sg_bar_t bar)
2171       .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2172
2173
2174 .. _API_s4u_ConditionVariable:
2175
2176 ==========================
2177 ⁣  Condition variable
2178 ==========================
2179
2180 .. doxygenclass:: simgrid::s4u::ConditionVariable
2181
2182 Basic management
2183 ----------------
2184
2185    .. tabs::
2186
2187       .. group-tab:: C++
2188
2189          .. code-block:: C++
2190
2191             #include <simgrid/s4u/ConditionVariable.hpp>
2192
2193          .. doxygentypedef:: ConditionVariablePtr
2194
2195          .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2196
2197       .. group-tab:: C
2198
2199          .. code-block:: C
2200
2201             #include <simgrid/cond.h>
2202
2203          .. doxygentypedef:: sg_cond_t
2204          .. doxygentypedef:: const_sg_cond_t
2205          .. doxygenfunction:: sg_cond_init
2206          .. doxygenfunction:: sg_cond_destroy
2207
2208 Waiting and notifying
2209 ---------------------
2210
2211    .. tabs::
2212
2213       .. group-tab:: C++
2214
2215          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2216          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2217          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2218          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2219          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2220          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2221          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2222          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2223          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2224          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2225          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2226          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2227          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2228
2229       .. group-tab:: C
2230
2231          .. doxygenfunction:: sg_cond_notify_all
2232          .. doxygenfunction:: sg_cond_notify_one
2233          .. doxygenfunction:: sg_cond_wait
2234          .. doxygenfunction:: sg_cond_wait_for
2235
2236 .. _API_s4u_Semaphore:
2237
2238 ==================
2239 ⁣  Semaphore
2240 ==================
2241
2242 .. doxygenclass:: simgrid::s4u::Semaphore
2243
2244
2245 Basic management
2246 ----------------
2247
2248    .. tabs::
2249
2250       .. group-tab:: C++
2251
2252          .. code-block:: C++
2253
2254             #include <simgrid/s4u/Semaphore.hpp>
2255
2256          .. doxygentypedef:: SemaphorePtr
2257          .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2258
2259       .. group-tab:: C
2260
2261          .. code-block:: C
2262
2263             #include <simgrid/semaphore.h>
2264
2265          .. doxygentypedef:: sg_sem_t
2266          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2267
2268             Pointer to a constant semaphore object.
2269
2270          .. doxygenfunction:: sg_sem_init(int initial_value)
2271          .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2272
2273 Locking
2274 -------
2275
2276    .. tabs::
2277
2278       .. group-tab:: C++
2279
2280          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2281          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2282          .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2283          .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2284          .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2285
2286       .. group-tab:: C
2287
2288          .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2289          .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2290          .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2291          .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2292          .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)
2293
2294 .. |hr| raw:: html
2295
2296    <hr />