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 .. rst-class:: compact-list
  68
  69    - **Simulation Elements**
  70
  71       - :ref:`class Actor <API_s4u_Actor>`: Active entities executing your application.
  72       - :ref:`class Engine <API_s4u_Engine>`: Simulation engine (singleton).
  73       - :ref:`class Mailbox <API_s4u_Mailbox>`: Communication rendezvous, with which actors meet each other.
  74
  75    - **Resources**
  76
  77       - :ref:`class Disk <API_s4u_Disk>`: Resource on which actors can write and read data.
  78       - :ref:`class Host <API_s4u_Host>`: Actor location, providing computational power.
  79       - :ref:`class Link <API_s4u_Link>`: Interconnecting hosts.
  80       - :ref:`class NetZone <API_s4u_NetZone>`: Sub-region of the platform, containing resources (Hosts, Links, etc).
  81       - :ref:`class VirtualMachine <API_s4u_VirtualMachine>`: Execution containers that can be moved between Hosts.
  82
  83    - **Activities** (:ref:`class Activity <API_s4u_Activity>`): The things that actors can do on resources.
  84
  85       - :ref:`class Comm <API_s4u_Comm>`: Communication activity, started on Mailboxes and consuming links.
  86       - :ref:`class Exec <API_s4u_Exec>`: Computation activity, started on Host and consuming CPU resources.
  87       - :ref:`class Io <API_s4u_Io>`: I/O activity, started on and consuming disks.
  88
  89    - **Synchronization Objects**: Classical IPC that actors can use
  90
  91       - :ref:`class Barrier <API_s4u_Barrier>`
  92       - :ref:`class ConditionVariable <API_s4u_ConditionVariable>`
  93       - :ref:`class Mutex <API_s4u_Mutex>`
  94       - :ref:`class Semaphore <API_s4u_Semaphore>`
  95
  96 .. |API_s4u_Actors| replace:: **Actors**
  97 .. _API_s4u_Actors: #api-s4u-actor
  98
  99 .. |API_s4u_Activities| replace:: **Activities**
 100 .. _API_s4u_Activities: #api-s4u-activity
 101
 102 .. |API_s4u_Hosts| replace:: **Hosts**
 103 .. _API_s4u_Hosts: #api-s4u-host
 104
 105 .. |API_s4u_Links| replace:: **Links**
 106 .. _API_s4u_Links: #api-s4u-link
 107
 108 .. |API_s4u_Disks| replace:: **Disks**
 109 .. _API_s4u_Disks: #api-s4u-disk
 110
 111 .. |API_s4u_VirtualMachine| replace:: **VirtualMachines**
 112
 113 .. |API_s4u_Host| replace:: **Host**
 114
 115 .. |API_s4u_Mailbox| replace:: **Mailbox**
 116
 117 .. |API_s4u_Mailboxes| replace:: **Mailboxes**
 118 .. _API_s4u_Mailboxes: #s4u-mailbox
 119
 120 .. |API_s4u_NetZone| replace:: **NetZone**
 121
 122 .. |API_s4u_Barrier| replace:: **Barrier**
 123
 124 .. |API_s4u_Semaphore| replace:: **Semaphore**
 125
 126 .. |API_s4u_ConditionVariable| replace:: **ConditionVariable**
 127
 128 .. |API_s4u_Mutex| replace:: **Mutex**
 129
 130 .. _s4u_Activities:
 131
 132 Activities
 133 **********
 134
 135 Activities represent the actions that consume a resource, such as a
 136 :ref:`Comm <API_s4u_Comm>` that consumes the *transmitting power* of
 137 :ref:`Link <API_s4u_Link>` resources, or an :ref:`Exec <API_s4u_Exec>`
 138 that consumes the *computing power* of :ref:`Host <API_s4u_Host>` resources.
 139 See also the :ref:`full API <API_s4u_Activity>` below.
 140
 141 =======================
 142 Asynchronous Activities
 143 =======================
 144
 145 Every activity can be either **blocking** or **asynchronous**. For
 146 example, :cpp:func:`s4u::Mailbox::put() <simgrid::s4u::Mailbox::put>`
 147 and :cpp:func:`s4u::Mailbox::get() <simgrid::s4u::Mailbox::get>`
 148 create blocking communications: the actor is blocked until the
 149 completion of that communication. Asynchronous communications do not
 150 block the actor during their execution but progress on their own.
 151
 152 Once your asynchronous activity is started, you can test for its
 153 completion using :cpp:func:`s4u::Activity::test() <simgrid::s4u::Activity::test>`.
 154 This function returns ``true`` if the activity is completed already.
 155 You can also use :cpp:func:`s4u::Activity::wait() <simgrid::s4u::Activity::wait>`
 156 to block until the completion of the activity. To wait for at most a given amount of time,
 157 use  :cpp:func:`s4u::Activity::wait_for() <simgrid::s4u::Activity::wait_for>`.
 158 Finally, to wait at most until a specified time limit, use
 159 :cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
 160
 161 Every kind of activity can be asynchronous.
 162 :ref:`s4u::CommPtr <API_s4u_Comm>` are created with :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
 163 :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`;
 164 :ref:`s4u::IoPtr <API_s4u_Io>` are created with :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
 165 :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`; and
 166 :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
 167 :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
 168 In the future, it will become possible to have asynchronous IPC such as asynchronous mutex lock requests.
 169
 170 The following example shows how to have several concurrent
 171 communications ongoing.  First, you have to declare a vector in which
 172 we will store the ongoing communications. It is also useful to have a
 173 vector of mailboxes.
 174
 175 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
 176    :language: c++
 177    :start-after: init-begin
 178    :end-before: init-end
 179    :dedent: 2
 180
 181 Then, you start all the communications that should occur concurrently with
 182 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
 183 Finally, the actor waits for the completion of all of them at once
 184 with :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
 185
 186 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
 187    :language: c++
 188    :start-after: put-begin
 189    :end-before: put-end
 190    :dedent: 2
 191
 192 =====================
 193 Activities Life cycle
 194 =====================
 195
 196 Sometimes, you want to change the setting of an activity before it even starts.
 197
 198 .. todo:: write this section
 199
 200 .. _s4u_mailbox:
 201
 202 Mailboxes
 203 *********
 204
 205 Please also refer to the :ref:`API reference for s4u::Mailbox
 206 <API_s4u_Mailbox>`.
 207
 208 ===================
 209 What are Mailboxes?
 210 ===================
 211
 212 |API_s4u_Mailboxes|_ are rendezvous points for network communications,
 213 similar to URLs on which you could post and retrieve data. Actually,
 214 the mailboxes are not involved in the communication once it starts,
 215 but only to find the contact with which you want to communicate.
 216
 217 They are similar to many common things: The phone number, which allows
 218 the caller to find the receiver. The Twitter hashtag, which helps
 219 senders and receivers to find each other. In TCP, the pair
 220 ``{host name, host port}`` to which you can connect to find your peer.
 221 In HTTP, URLs through which the clients can connect to the servers.
 222 In ZeroMQ, the queues are used to match senders and receivers.
 223
 224 One big difference with most of these systems is that no actor is the
 225 exclusive owner of a mailbox, neither in sending nor in receiving.
 226 Many actors can send into and/or receive from the same mailbox.  TCP
 227 socket ports for example are shared on the sender side but exclusive
 228 on the receiver side (only one process can receive from a given socket
 229 at a given point of time).
 230
 231 A big difference with TCP sockets or MPI communications is that
 232 communications do not start right away after a
 233 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put>`, but wait
 234 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get>`.
 235 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
 236
 237 A big difference with Twitter hashtags is that SimGrid does not
 238 offer easy support to broadcast a given message to many
 239 receivers. So that would be like a Twitter tag where each message
 240 is consumed by the first receiver.
 241
 242 A big difference with the ZeroMQ queues is that you cannot filter
 243 on the data you want to get from the mailbox. To model such settings
 244 in SimGrid, you'd have one mailbox per potential topic, and subscribe
 245 to each topic individually with a
 246 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async>` on each mailbox.
 247 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any>`
 248 to get the first message on any of the mailboxes you are subscribed to.
 249
 250 The mailboxes are not located on the network, and you can access
 251 them without any latency. The network delays are only related to the
 252 location of the sender and receiver once the match between them is
 253 done on the mailbox. This is just like the phone number that you
 254 can use locally, and the geographical distance only comes into play
 255 once you start the communication by dialing this number.
 256
 257 =====================
 258 How to use Mailboxes?
 259 =====================
 260
 261 You can retrieve any existing mailbox from its name (which is a
 262 unique string, just like a Twitter tag). This results in a
 263 versatile tool that can be used to build many different
 264 situations.
 265
 266 To model classical socket communications, use "hostname:port" as
 267 mailbox names, and make sure that only one actor reads into a given
 268 mailbox. This does not make it easy to build a perfectly realistic
 269 model of the TCP sockets, but in most cases, this system is too
 270 cumbersome for your simulations anyway. You probably want something
 271 simpler, that turns out to be easy to build with the mailboxes.
 272
 273 Many SimGrid examples use a sort of yellow page system where the
 274 mailbox names are the name of the service (such as "worker",
 275 "master", or "reducer"). That way, you don't have to know where your
 276 peer is located to contact it. You don't even need its name. Its
 277 function is enough for that. This also gives you some sort of load
 278 balancing for free if more than one actor pulls from the mailbox:
 279 the first actor that can deal with the request will handle it.
 280
 281 =========================================
 282 How are put() and get() requests matched?
 283 =========================================
 284
 285 The matching algorithm simple: first come, first serve. When a new
 286 send arrives, it matches the oldest enqueued receive. If no receive is
 287 currently enqueued, then the incoming send is enqueued. As you can
 288 see, the mailbox cannot contain both send and receive requests: all
 289 enqueued requests must be of the same sort.
 290
 291 .. _s4u_receiving_actor:
 292
 293 ===========================
 294 Declaring a Receiving Actor
 295 ===========================
 296
 297 The last twist is that by default in the simulator, the data starts
 298 to be exchanged only when both the sender and the receiver are
 299 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 300 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
 301 In TCP, since you establish connections beforehand, the data starts to
 302 flow as soon as the sender posts it, even if the receiver did not post
 303 its :cpp:func:`put() <simgrid::s4u::Mailbox::put()>` yet.
 304
 305 To model this in SimGrid, you can declare a specific receiver to a
 306 given mailbox (with the function
 307 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
 308 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 309 posted to that mailbox will start as soon as possible, and the data
 310 will already be there on the receiver host when the receiver actor
 311 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
 312
 313 Note that being permanent receivers of a mailbox prevents actors to be
 314 garbage-collected. If your simulation creates many short-lived actors
 315 that are marked as permanent receiver, you should call
 316 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
 317 memory gets properly reclaimed. This call should be at the end of the
 318 actor's function, not in an on_exit callback.
 319
 320 ===============================
 321 Communicating without Mailboxes
 322 ===============================
 323
 324 Sometimes you don't want to simulate communications between actors as
 325 allowed by mailboxes, but you want to create a direct communication
 326 between two arbitrary hosts. This can arise when you write a
 327 high-level model of a centralized scheduler, or when you model direct
 328 communications such as one-sided communications in MPI or remote
 329 memory direct access in PGAS.
 330
 331 For that, :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`
 332 simulates a direct communication between the two specified hosts. No
 333 mailbox is used, and there is no rendezvous between actors. You can
 334 freely mix such direct communications and rendezvous-based
 335 communications. Alternatively, :cpp:func:`Comm::sendto_init()
 336 <simgrid::s4u::Comm::sendto_init()>` and
 337 :cpp:func:`Comm::sendto_async() <simgrid::s4u::Comm::sendto_async()>`
 338 create asynchronous direct communications.
 339
 340 .. _s4u_raii:
 341
 342 Memory Management
 343 *****************
 344
 345 For sake of simplicity, we use `RAII
 346 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 347 for many classes in S4U. This is an idiom where resources are automatically
 348 managed through the context. Provided that you never manipulate
 349 objects of type Foo directly but always FooPtr references (which are
 350 defined as `boost::intrusive_ptr
 351 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 352 <Foo>), you will never have to explicitly release the resource that
 353 you use nor to free the memory of unused objects.
 354 Here is a little example:
 355
 356 .. code-block:: cpp
 357
 358    void myFunc()
 359    {
 360      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 361
 362      mutex->lock();   // use the mutex as a simple reference
 363      //  bla bla
 364      mutex->unlock();
 365
 366    } // The mutex gets automatically freed because the only existing reference gets out of scope
 367
 368 Note that Mailboxes, Hosts, and Links are not handled through smart
 369 pointers (yet?). This means that it is currently impossible to destroy a
 370 mailbox or a link. You can still destroy a host (but probably
 371 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 372
 373 .. THE EXAMPLES
 374
 375 .. include:: ../../examples/README.rst
 376
 377 API Reference
 378 *************
 379
 380 .. _API_s4u_simulation_object:
 381
 382 ==================
 383 Simulation objects
 384 ==================
 385
 386 .. _API_s4u_Actor:
 387
 388 ==============
 389 ⁣  class Actor
 390 ==============
 391
 392 .. tabs::
 393
 394    .. group-tab:: C++
 395
 396       .. doxygenclass:: simgrid::s4u::Actor
 397
 398       .. doxygentypedef:: aid_t
 399
 400
 401    .. group-tab:: Python
 402
 403       .. autoclass:: simgrid.Actor
 404
 405 Basic management
 406 ----------------
 407
 408 .. tabs::
 409
 410    .. group-tab:: C++
 411
 412       .. code:: C++
 413
 414          #include <simgrid/s4u/Actor.hpp>
 415
 416       .. doxygentypedef:: ActorPtr
 417
 418    .. group-tab:: Python
 419
 420       .. code:: Python
 421
 422          from simgrid import Actor
 423
 424    .. group-tab:: C
 425
 426       .. code:: C
 427
 428          #include <simgrid/actor.h>
 429
 430       .. doxygentypedef:: sg_actor_t
 431       .. doxygentypedef:: const_sg_actor_t
 432       .. doxygenfunction:: sg_actor_ref
 433       .. doxygenfunction:: sg_actor_unref
 434
 435
 436 Creating actors
 437 ---------------
 438
 439 See also :ref:`the relevant example <s4u_ex_actors_create>`.
 440
 441 .. tabs::
 442
 443    .. group-tab:: C++
 444
 445       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 446       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 447       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 448       .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 449
 450       .. doxygenfunction:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 451       .. doxygenfunction:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 452       .. doxygenfunction:: simgrid::s4u::Actor::set_stacksize
 453
 454    .. group-tab:: Python
 455
 456       .. automethod:: simgrid.Actor.create
 457
 458    .. group-tab:: C
 459
 460       .. doxygenfunction:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, char *const *argv)
 461       .. doxygenfunction:: sg_actor_init(const char *name, sg_host_t host)
 462       .. doxygenfunction:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char *const *argv)
 463       .. doxygenfunction:: sg_actor_set_stacksize
 464
 465       .. doxygenfunction:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 466       .. doxygenfunction:: sg_actor_detach()
 467
 468 Retrieving actors
 469 -----------------
 470
 471 .. tabs::
 472
 473    .. group-tab:: C++
 474
 475       .. doxygenfunction:: simgrid::s4u::Actor::by_pid(aid_t pid)
 476       .. doxygenfunction:: simgrid::s4u::Actor::self()
 477
 478    .. group-tab:: Python
 479
 480       .. automethod:: simgrid.Actor.by_pid
 481       .. automethod:: simgrid.Actor.self
 482
 483    .. group-tab:: C
 484
 485       .. doxygenfunction:: sg_actor_by_pid(aid_t pid)
 486       .. doxygenfunction:: sg_actor_self()
 487       .. doxygenfunction:: sg_actor_list()
 488
 489 Querying info
 490 -------------
 491
 492 .. tabs::
 493
 494    .. group-tab:: C++
 495
 496       .. doxygenfunction:: simgrid::s4u::Actor::get_cname
 497       .. doxygenfunction:: simgrid::s4u::Actor::get_name
 498       .. doxygenfunction:: simgrid::s4u::Actor::get_pid
 499       .. doxygenfunction:: simgrid::s4u::Actor::get_ppid
 500       .. doxygenfunction:: simgrid::s4u::Actor::get_properties() const
 501       .. doxygenfunction:: simgrid::s4u::Actor::get_property(const std::string &key) const
 502       .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 503
 504       .. doxygenfunction:: simgrid::s4u::Actor::get_host
 505       .. doxygenfunction:: simgrid::s4u::Actor::set_host
 506
 507       .. doxygenfunction:: simgrid::s4u::Actor::get_refcount
 508       .. doxygenfunction:: simgrid::s4u::Actor::get_impl
 509
 510    .. group-tab:: Python
 511
 512       .. autoattribute:: simgrid.Actor.name
 513       .. autoattribute:: simgrid.Actor.host
 514       .. autoattribute:: simgrid.Actor.pid
 515       .. autoattribute:: simgrid.Actor.ppid
 516
 517    .. group-tab:: C
 518
 519       .. doxygenfunction:: sg_actor_get_name(const_sg_actor_t actor)
 520       .. doxygenfunction:: sg_actor_get_pid(const_sg_actor_t actor)
 521       .. doxygenfunction:: sg_actor_get_ppid(const_sg_actor_t actor)
 522       .. doxygenfunction:: sg_actor_get_properties(const_sg_actor_t actor)
 523       .. doxygenfunction:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 524
 525       .. doxygenfunction:: sg_actor_get_host(const_sg_actor_t actor)
 526       .. doxygenfunction:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 527
 528       .. doxygenfunction:: sg_actor_get_data(const_sg_actor_t actor)
 529       .. doxygenfunction:: sg_actor_set_data(sg_actor_t actor, void *userdata)
 530
 531 Suspending and resuming actors
 532 ------------------------------
 533
 534 .. tabs::
 535
 536    .. group-tab:: C++
 537
 538       .. doxygenfunction:: simgrid::s4u::Actor::suspend()
 539       .. doxygenfunction:: simgrid::s4u::Actor::resume()
 540       .. doxygenfunction:: simgrid::s4u::Actor::is_suspended
 541
 542    .. group-tab:: Python
 543
 544       .. automethod:: simgrid.Actor.resume
 545       .. automethod:: simgrid.Actor.suspend
 546       .. automethod:: simgrid.Actor.is_suspended
 547
 548    .. group-tab:: C
 549
 550       .. doxygenfunction:: sg_actor_suspend(sg_actor_t actor)
 551       .. doxygenfunction:: sg_actor_resume(sg_actor_t actor)
 552       .. doxygenfunction:: sg_actor_is_suspended(const_sg_actor_t actor)
 553
 554 Specifying when actors should terminate
 555 ---------------------------------------
 556
 557 .. tabs::
 558
 559    .. group-tab:: C++
 560
 561       .. doxygenfunction:: simgrid::s4u::Actor::kill()
 562       .. doxygenfunction:: simgrid::s4u::Actor::kill_all()
 563       .. doxygenfunction:: simgrid::s4u::Actor::set_kill_time(double time)
 564       .. doxygenfunction:: simgrid::s4u::Actor::get_kill_time
 565
 566       .. doxygenfunction:: simgrid::s4u::Actor::restart()
 567       .. doxygenfunction:: simgrid::s4u::Actor::daemonize()
 568       .. doxygenfunction:: simgrid::s4u::Actor::is_daemon
 569
 570    .. group-tab:: Python
 571
 572       .. automethod:: simgrid.Actor.kill
 573       .. automethod:: simgrid.Actor.kill_all
 574
 575       .. automethod:: simgrid.Actor.daemonize
 576       .. automethod:: simgrid.Actor.is_daemon
 577
 578    .. group-tab:: C
 579
 580       .. doxygenfunction:: sg_actor_kill(sg_actor_t actor)
 581       .. doxygenfunction:: sg_actor_kill_all()
 582       .. doxygenfunction:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 583
 584       .. doxygenfunction:: sg_actor_restart(sg_actor_t actor)
 585       .. doxygenfunction:: sg_actor_daemonize(sg_actor_t actor)
 586       .. doxygenfunction:: sg_actor_is_daemon
 587
 588 .. _API_s4u_Actor_end:
 589
 590 Reacting to the end of actors
 591 -----------------------------
 592
 593 .. tabs::
 594
 595    .. group-tab:: C++
 596
 597       .. doxygenfunction:: simgrid::s4u::Actor::on_exit
 598       .. doxygenfunction:: simgrid::s4u::Actor::join() const
 599       .. doxygenfunction:: simgrid::s4u::Actor::join(double timeout) const
 600       .. doxygenfunction:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 601
 602    .. group-tab:: Python
 603
 604       .. automethod:: simgrid.Actor.join
 605
 606    .. group-tab:: C
 607
 608       .. doxygenfunction:: sg_actor_on_exit
 609       .. doxygenfunction:: sg_actor_join(const_sg_actor_t actor, double timeout)
 610       .. doxygenfunction:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 611
 612 Signals
 613 -------
 614
 615 .. tabs::
 616
 617    .. group-tab:: C++
 618
 619       .. doxygenfunction:: simgrid::s4u::Actor::on_creation_cb
 620       .. doxygenfunction:: simgrid::s4u::Actor::on_suspend_cb
 621       .. doxygenfunction:: simgrid::s4u::Actor::on_host_change_cb
 622       .. doxygenfunction:: simgrid::s4u::Actor::on_resume_cb
 623       .. doxygenfunction:: simgrid::s4u::Actor::on_sleep_cb
 624       .. doxygenfunction:: simgrid::s4u::Actor::on_wake_up_cb
 625       .. doxygenfunction:: simgrid::s4u::Actor::on_termination_cb
 626       .. doxygenfunction:: simgrid::s4u::Actor::on_destruction_cb
 627
 628 .. _API_s4u_this_actor:
 629
 630 ====================
 631 ⁣  The current actor
 632 ====================
 633
 634 These functions can be used in your user code to interact with the actor
 635 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 636 Using these functions can greatly improve the code readability.
 637
 638 Querying info
 639 -------------
 640
 641 .. tabs::
 642
 643    .. group-tab:: C++
 644
 645       .. doxygenfunction:: simgrid::s4u::this_actor::get_cname()
 646       .. doxygenfunction:: simgrid::s4u::this_actor::get_name()
 647       .. doxygenfunction:: simgrid::s4u::this_actor::get_pid()
 648       .. doxygenfunction:: simgrid::s4u::this_actor::get_ppid()
 649       .. doxygenfunction:: simgrid::s4u::this_actor::is_maestro()
 650
 651       .. doxygenfunction:: simgrid::s4u::this_actor::get_host()
 652       .. doxygenfunction:: simgrid::s4u::this_actor::set_host(Host *new_host)
 653
 654    .. group-tab:: Python
 655
 656       .. autofunction:: simgrid.this_actor.get_host
 657       .. autofunction:: simgrid.this_actor.set_host
 658
 659       .. autofunction:: simgrid.this_actor.get_pid
 660       .. autofunction:: simgrid.this_actor.get_ppid
 661
 662    .. group-tab:: C
 663
 664       .. doxygenfunction:: sg_actor_self_get_data()
 665       .. doxygenfunction:: sg_actor_self_set_data(void *data)
 666       .. doxygenfunction:: sg_actor_self_get_name()
 667       .. doxygenfunction:: sg_actor_self_get_pid()
 668       .. doxygenfunction:: sg_actor_self_get_ppid()
 669       .. doxygenfunction:: sg_host_self()
 670       .. doxygenfunction:: sg_host_self_get_name()
 671
 672 Suspending and resuming
 673 -----------------------
 674
 675 .. tabs::
 676
 677    .. group-tab:: C++
 678
 679       .. doxygenfunction:: simgrid::s4u::this_actor::suspend()
 680       .. doxygenfunction:: simgrid::s4u::this_actor::yield()
 681
 682    .. group-tab:: Python
 683
 684       .. autofunction:: simgrid.this_actor.suspend
 685       .. autofunction:: simgrid.this_actor.yield_
 686
 687    .. group-tab:: C
 688
 689       .. doxygenfunction:: sg_actor_yield()
 690
 691 Logging messages
 692 ----------------
 693
 694 .. tabs::
 695
 696    .. group-tab:: C++
 697
 698       Please refer to :ref:`the relevant documentation <logging_prog>`.
 699
 700    .. group-tab:: Python
 701
 702        .. autofunction:: simgrid.this_actor.debug
 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
 745    .. group-tab:: Python
 746
 747       .. autofunction:: simgrid.this_actor.exec_init
 748       .. autofunction:: simgrid.this_actor.execute
 749
 750    .. group-tab:: C
 751
 752       .. doxygenfunction:: sg_actor_execute(double flops)
 753       .. doxygenfunction:: sg_actor_execute_with_priority(double flops, double priority)
 754       .. doxygenfunction:: sg_actor_exec_init(double computation_amount)
 755       .. doxygenfunction:: sg_actor_exec_async(double computation_amount)
 756       .. doxygenfunction:: sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount, double* bytes_amount);
 757
 758 Exiting
 759 -------
 760
 761 .. tabs::
 762
 763    .. group-tab:: C++
 764
 765       .. doxygenfunction:: simgrid::s4u::this_actor::exit()
 766       .. doxygenfunction:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 767
 768    .. group-tab:: Python
 769
 770       .. autofunction:: simgrid.this_actor.exit
 771       .. autofunction:: simgrid.this_actor.on_exit
 772
 773    .. group-tab:: c
 774
 775       See also :cpp:func:`sg_actor_on_exit`.
 776
 777       .. doxygenfunction:: sg_actor_exit
 778
 779 .. _API_s4u_Engine:
 780
 781 ====================
 782 ⁣  Simulation Engine
 783 ====================
 784
 785 .. tabs::
 786
 787    .. group-tab:: C++
 788
 789       .. doxygenclass:: simgrid::s4u::Engine
 790
 791    .. group-tab:: Python
 792
 793       .. autoclass:: simgrid.Engine
 794
 795 Engin initialization
 796 --------------------
 797
 798 .. tabs::
 799
 800    .. group-tab:: C++
 801
 802       .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 803       .. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
 804       .. doxygenfunction:: simgrid::s4u::Engine::shutdown()
 805       .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
 806
 807    .. group-tab:: Python
 808
 809        .. automethod:: simgrid.Engine.__init__
 810        .. automethod:: simgrid.Engine.instance
 811
 812    .. group-tab:: C
 813
 814       .. doxygenfunction:: simgrid_init
 815
 816 Simulation setup
 817 ----------------
 818
 819 .. tabs::
 820
 821    .. group-tab:: C++
 822
 823       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
 824       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
 825       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
 826       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
 827       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
 828
 829       .. doxygenfunction:: simgrid::s4u::Engine::load_deployment
 830       .. doxygenfunction:: simgrid::s4u::Engine::load_platform
 831       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name)
 832       .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 833       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
 834       .. doxygenfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
 835
 836       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
 837       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
 838       .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
 839
 840    .. group-tab:: Python
 841
 842        .. automethod:: simgrid.Engine.load_deployment
 843        .. automethod:: simgrid.Engine.load_platform
 844        .. automethod:: simgrid.Engine.register_actor
 845
 846    .. group-tab:: C
 847
 848       .. doxygenfunction:: simgrid_load_deployment
 849       .. doxygenfunction:: simgrid_load_platform
 850       .. doxygenfunction:: simgrid_register_default
 851       .. doxygenfunction:: simgrid_register_function
 852
 853
 854 Run the simulation
 855 ------------------
 856
 857 .. tabs::
 858
 859    .. group-tab:: C++
 860
 861       .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
 862       .. doxygenfunction:: simgrid::s4u::Engine::run
 863       .. doxygenfunction:: simgrid::s4u::Engine::run_until
 864
 865    .. group-tab:: Python
 866
 867       .. automethod:: simgrid.Engine.get_clock
 868       .. automethod:: simgrid.Engine.run
 869       .. automethod:: simgrid.Engine.run_until
 870
 871    .. group-tab:: C
 872
 873       .. doxygenfunction:: simgrid_get_clock
 874       .. doxygenfunction:: simgrid_run
 875       .. doxygenfunction:: simgrid_run_until
 876
 877 Retrieving actors
 878 -----------------
 879
 880 .. tabs::
 881
 882    .. group-tab:: C++
 883
 884       .. doxygenfunction:: simgrid::s4u::Engine::get_actor_count
 885       .. doxygenfunction:: simgrid::s4u::Engine::get_all_actors
 886       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_actors
 887
 888    .. group-tab:: C
 889
 890       .. doxygenfunction:: sg_actor_count()
 891
 892 Retrieving hosts
 893 ----------------
 894
 895 .. tabs::
 896
 897    .. group-tab:: C++
 898
 899       .. doxygenfunction:: simgrid::s4u::Engine::get_all_hosts
 900       .. doxygenfunction:: simgrid::s4u::Engine::get_host_count
 901       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_hosts
 902       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name
 903       .. doxygenfunction:: simgrid::s4u::Engine::host_by_name_or_null
 904
 905    .. group-tab:: Python
 906
 907       .. automethod:: simgrid.Engine.get_all_hosts
 908
 909    .. group-tab:: C
 910
 911       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 912
 913 Retrieving links
 914 ----------------
 915
 916 .. tabs::
 917
 918    .. group-tab:: C++
 919
 920       .. doxygenfunction:: simgrid::s4u::Engine::get_all_links
 921       .. doxygenfunction:: simgrid::s4u::Engine::get_link_count
 922       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_links
 923       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name
 924       .. doxygenfunction:: simgrid::s4u::Engine::link_by_name_or_null
 925
 926    .. group-tab:: Python
 927
 928       .. automethod:: simgrid.Engine.get_all_links
 929
 930 Interacting with the routing
 931 ----------------------------
 932
 933 .. tabs::
 934
 935    .. group-tab:: C++
 936
 937       .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
 938       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
 939       .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
 940       .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
 941       .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
 942       .. doxygenfunction:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 943
 944    .. group-tab:: Python
 945
 946       .. automethod:: simgrid.Engine.get_all_netpoints
 947       .. automethod:: simgrid.Engine.get_netzone_root
 948       .. automethod:: simgrid.Engine.netpoint_by_name_or_null
 949       .. automethod:: simgrid.Engine.netzone_by_name_or_null
 950       .. automethod:: simgrid.Engine.set_netzone_root
 951
 952 Signals
 953 -------
 954
 955 .. tabs::
 956
 957    .. group-tab:: C++
 958
 959       .. doxygenfunction:: simgrid::s4u::Engine::on_deadlock_cb
 960       .. doxygenfunction:: simgrid::s4u::Engine::on_platform_created_cb
 961       .. doxygenfunction:: simgrid::s4u::Engine::on_platform_creation_cb
 962       .. doxygenfunction:: simgrid::s4u::Engine::on_simulation_end_cb
 963       .. doxygenfunction:: simgrid::s4u::Engine::on_time_advance_cb
 964
 965 .. _API_s4u_Mailbox:
 966
 967 ================
 968 ⁣  class Mailbox
 969 ================
 970
 971 .. tabs::
 972
 973    .. group-tab:: C++
 974
 975       .. doxygenclass:: simgrid::s4u::Mailbox
 976
 977    .. group-tab:: Python
 978
 979       .. autoclass:: simgrid.Mailbox
 980
 981 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 982
 983 Basic management
 984 ----------------
 985
 986 .. tabs::
 987
 988    .. group-tab:: C++
 989
 990       .. code-block:: C++
 991
 992          #include <simgrid/s4u/Mailbox.hpp>
 993
 994       Note that there is no MailboxPtr type and that you cannot use the RAII
 995       idiom on mailboxes because they are internal objects to the simulation
 996       engine. Once created, there is no way to destroy a mailbox before the end
 997       of the simulation.
 998
 999       .. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
1000
1001    .. group-tab:: Python
1002
1003       .. code-block:: C++
1004
1005          #include <simgrid/mailbox.h>
1006
1007       .. automethod:: simgrid.Mailbox.by_name
1008
1009    .. group-tab:: C
1010
1011       .. code-block:: C
1012
1013          #include <simgrid/s4u/mailbox.h>
1014
1015       .. doxygentypedef:: sg_mailbox_t
1016       .. doxygentypedef:: const_sg_mailbox_t
1017
1018       .. doxygenfunction:: sg_mailbox_by_name(const char *alias)
1019
1020 Querying info
1021 -------------
1022
1023 .. tabs::
1024
1025    .. group-tab:: C++
1026
1027       .. doxygenfunction:: simgrid::s4u::Mailbox::get_cname
1028       .. doxygenfunction:: simgrid::s4u::Mailbox::get_name
1029
1030    .. group-tab:: Python
1031
1032       .. autoattribute:: simgrid.Mailbox.name
1033
1034 Sending data
1035 ------------
1036
1037 .. tabs::
1038
1039    .. group-tab:: C++
1040
1041       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
1042       .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
1043       .. doxygenfunction:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
1044       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init()
1045       .. doxygenfunction:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
1046
1047    .. group-tab:: Python
1048
1049       .. automethod:: simgrid.Mailbox.put
1050       .. automethod:: simgrid.Mailbox.put_async
1051
1052    .. group-tab:: C
1053
1054       .. doxygenfunction:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1055       .. doxygenfunction:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1056       .. doxygenfunction:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1057
1058
1059 Receiving data
1060 --------------
1061
1062 .. tabs::
1063
1064    .. group-tab:: C++
1065
1066       .. doxygenfunction:: simgrid::s4u::Mailbox::empty
1067       .. doxygenfunction:: simgrid::s4u::Mailbox::front
1068       .. doxygenfunction:: simgrid::s4u::Mailbox::get()
1069       .. doxygenfunction:: simgrid::s4u::Mailbox::get(double timeout)
1070       .. doxygenfunction:: simgrid::s4u::Mailbox::get_async(T **data)
1071       .. doxygenfunction:: simgrid::s4u::Mailbox::get_init()
1072       .. doxygenfunction:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
1073       .. doxygenfunction:: simgrid::s4u::Mailbox::listen
1074       .. doxygenfunction:: simgrid::s4u::Mailbox::ready
1075
1076    .. group-tab:: Python
1077
1078        .. automethod:: simgrid.Mailbox.get
1079        .. automethod:: simgrid.Mailbox.get_async
1080
1081    .. group-tab:: C
1082
1083       .. doxygenfunction:: sg_mailbox_get(sg_mailbox_t mailbox)
1084       .. doxygenfunction:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1085       .. doxygenfunction:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1086       .. doxygenfunction:: sg_mailbox_listen(const char *alias)
1087
1088 Receiving actor
1089 ---------------
1090
1091 See :ref:`s4u_receiving_actor`.
1092
1093 .. tabs::
1094
1095    .. group-tab:: C++
1096
1097       .. doxygenfunction:: simgrid::s4u::Mailbox::get_receiver
1098       .. doxygenfunction:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1099
1100    .. group-tab:: C
1101
1102       .. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
1103
1104 .. _API_s4u_Resource:
1105
1106 =========
1107 Resources
1108 =========
1109
1110 .. _API_s4u_Disk:
1111
1112 =============
1113 ⁣  class Disk
1114 =============
1115
1116 .. tabs::
1117
1118    .. group-tab:: C++
1119
1120       .. doxygenclass:: simgrid::s4u::Disk
1121
1122    .. group-tab:: Python
1123
1124       .. autoclass:: simgrid.Disk
1125
1126    .. group-tab:: C
1127
1128       .. doxygentypedef:: sg_disk_t
1129       .. doxygentypedef:: const_sg_disk_t
1130
1131 Basic management
1132 ----------------
1133
1134 .. tabs::
1135
1136    .. group-tab:: C++
1137
1138       .. code-block:: C++
1139
1140          #include <simgrid/s4u/Disk.hpp>
1141
1142       Note that there is no DiskPtr type and that you cannot use the RAII
1143       idiom on disks because SimGrid does not allow (yet) to create nor
1144       destroy resources once the simulation is started.
1145
1146       .. doxygenfunction:: simgrid::s4u::Disk::seal()
1147
1148    .. group-tab:: Python
1149
1150       .. code:: Python
1151
1152          from simgrid import Disk
1153
1154       .. automethod:: simgrid.Disk.seal
1155
1156
1157 Querying info
1158 -------------
1159
1160 .. tabs::
1161
1162    .. group-tab:: C++
1163
1164       .. doxygenfunction:: simgrid::s4u::Disk::get_cname() const
1165       .. doxygenfunction:: simgrid::s4u::Disk::get_host() const
1166       .. doxygenfunction:: simgrid::s4u::Disk::get_name() const
1167       .. doxygenfunction:: simgrid::s4u::Disk::get_properties() const
1168       .. doxygenfunction:: simgrid::s4u::Disk::get_property(const std::string &key) const
1169       .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
1170       .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
1171       .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1172       .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1173
1174    .. group-tab:: Python
1175
1176       .. autoattribute:: simgrid.Disk.name
1177       .. automethod:: simgrid.Disk.set_sharing_policy
1178
1179 I/O operations
1180 --------------
1181
1182 .. tabs::
1183
1184    .. group-tab:: C++
1185
1186       .. doxygenfunction:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type) const
1187       .. doxygenfunction:: simgrid::s4u::Disk::read(sg_size_t size) const
1188       .. doxygenfunction:: simgrid::s4u::Disk::read_async(sg_size_t size) const
1189       .. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
1190       .. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
1191
1192    .. group-tab:: Python
1193
1194       .. automethod:: simgrid.Disk.read
1195       .. automethod:: simgrid.Disk.read_async
1196       .. automethod:: simgrid.Disk.write
1197       .. automethod:: simgrid.Disk.write_async
1198
1199 Signals
1200 -------
1201
1202 .. tabs::
1203
1204    .. group-tab:: C++
1205
1206       .. doxygenfunction:: simgrid::s4u::Disk::on_creation_cb
1207       .. doxygenfunction:: simgrid::s4u::Disk::on_destruction_cb
1208       .. doxygenfunction:: simgrid::s4u::Disk::on_state_change_cb
1209
1210
1211 .. _API_s4u_Host:
1212
1213 =============
1214 ⁣  class Host
1215 =============
1216
1217 .. tabs::
1218
1219    .. group-tab:: C++
1220
1221       .. doxygenclass:: simgrid::s4u::Host
1222
1223    .. group-tab:: Python
1224
1225       .. autoclass:: simgrid.Host
1226
1227 Basic management
1228 ----------------
1229
1230 .. tabs::
1231
1232    .. group-tab:: C++
1233
1234       .. code-block:: C++
1235
1236          #include <simgrid/s4u/Host.hpp>
1237
1238       Note that there is no HostPtr type, and that you cannot use the RAII
1239       idiom on hosts because SimGrid does not allow (yet) to create nor
1240       destroy resources once the simulation is started.
1241
1242       .. doxygenfunction:: simgrid::s4u::Host::destroy()
1243       .. doxygenfunction:: simgrid::s4u::Host::seal()
1244
1245    .. group-tab:: Python
1246
1247       .. code:: Python
1248
1249          from simgrid import Host
1250
1251       .. automethod:: simgrid.Host.seal
1252
1253    .. group-tab:: C
1254
1255       .. code:: C
1256
1257          #include <simgrid/host.h>
1258
1259       .. doxygentypedef:: sg_host_t
1260       .. cpp:type:: const s4u_Host* const_sg_host_t
1261
1262          Pointer to a constant host object.
1263
1264 Retrieving hosts
1265 ----------------
1266
1267 .. tabs::
1268
1269    .. group-tab:: C++
1270
1271       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1272
1273       .. doxygenfunction:: simgrid::s4u::Host::by_name(const std::string &name)
1274       .. doxygenfunction:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1275       .. doxygenfunction:: simgrid::s4u::Host::current()
1276
1277    .. group-tab:: Python
1278
1279       See also :py:func:`simgrid.Engine.get_all_hosts`.
1280
1281       .. automethod:: simgrid.Host.by_name
1282       .. automethod:: simgrid.Host.current
1283
1284    .. group-tab:: C
1285
1286       .. doxygenfunction:: sg_host_by_name(const char *name)
1287       .. doxygenfunction:: sg_host_count()
1288       .. doxygenfunction:: sg_host_list()
1289
1290 Modifying characteristics
1291 -------------------------
1292
1293 .. tabs::
1294
1295    .. group-tab:: C++
1296
1297       .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count)
1298       .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords)
1299       .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1300
1301    .. group-tab:: Python
1302
1303       .. automethod:: simgrid.Host.set_core_count
1304       .. automethod:: simgrid.Host.set_coordinates
1305       .. automethod:: simgrid.Host.set_sharing_policy
1306
1307 Querying info
1308 -------------
1309
1310 .. tabs::
1311
1312    .. group-tab:: C++
1313
1314       .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1315       .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1316       .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1317       .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1318       .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1319       .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1320
1321    .. group-tab:: Python
1322
1323       .. autoattribute:: simgrid.Host.name
1324       .. autoattribute:: simgrid.Host.load
1325       .. autoattribute:: simgrid.Host.pstate
1326       .. autoattribute:: simgrid.Host.speed
1327
1328    .. group-tab:: C
1329
1330       .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1331       .. doxygenfunction:: sg_host_dump(const_sg_host_t ws)
1332       .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1333       .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1334       .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1335
1336 User data and properties
1337 ------------------------
1338
1339 .. tabs::
1340
1341    .. group-tab:: C++
1342
1343       .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1344       .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1345       .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1346       .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1347
1348    .. group-tab:: C
1349
1350       .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1351       .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1352       .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1353       .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1354       .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1355
1356 Retrieving components
1357 ---------------------
1358
1359 .. tabs::
1360
1361    .. group-tab:: C++
1362
1363       .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1364       .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1365       .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1366       .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1367       .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1368
1369    .. group-tab:: Python
1370
1371       .. automethod:: simgrid.Host.get_disks
1372
1373    .. group-tab:: C
1374
1375       .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1376
1377 On/Off
1378 ------
1379
1380 .. tabs::
1381
1382    .. group-tab:: C++
1383
1384       .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1385       .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1386       .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1387
1388    .. group-tab:: C
1389
1390       .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1391       .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1392       .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1393
1394 DVFS
1395 ----
1396
1397 .. tabs::
1398
1399    .. group-tab:: C++
1400
1401       .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1402       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1403       .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(unsigned long pstate_index) const
1404       .. doxygenfunction:: simgrid::s4u::Host::set_pstate(unsigned long pstate_index)
1405       .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1406       .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1407
1408    .. group-tab:: Python
1409
1410       .. automethod:: simgrid.Host.get_pstate_count
1411       .. automethod:: simgrid.Host.get_pstate_speed
1412       .. automethod:: simgrid.Host.set_speed_profile
1413
1414    .. group-tab:: C
1415
1416       .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1417       .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1418       .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1419       .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
1420       .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, unsigned long pstate)
1421
1422 Execution
1423 ---------
1424
1425 .. tabs::
1426
1427    .. group-tab:: C++
1428
1429       .. doxygenfunction:: simgrid::s4u::Host::exec_async
1430       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1431       .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1432
1433 Platform and routing
1434 --------------------
1435
1436 You can also start direct communications between two arbitrary hosts
1437 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1438
1439 .. tabs::
1440
1441    .. group-tab:: C++
1442
1443       .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1444       .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1445       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1446       .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::StandardLinkImpl * > &links, double *latency) const
1447       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
1448       .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
1449
1450    .. group-tab:: Python
1451
1452       .. automethod:: simgrid.Host.get_netpoint
1453       .. automethod:: simgrid.Host.create_disk
1454
1455       .. automethod:: simgrid.Host.route_to
1456
1457    .. group-tab:: C
1458
1459       .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1460       .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1461       .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1462       .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1463
1464 Signals
1465 -------
1466
1467 .. tabs::
1468
1469    .. group-tab:: C++
1470
1471       .. doxygenfunction:: simgrid::s4u::Host::on_creation_cb
1472       .. doxygenfunction:: simgrid::s4u::Host::on_destruction_cb
1473       .. doxygenfunction:: simgrid::s4u::Host::on_speed_change_cb
1474       .. doxygenfunction:: simgrid::s4u::Host::on_state_change_cb
1475
1476 .. _API_s4u_Link:
1477
1478 =============
1479 ⁣  class Link
1480 =============
1481
1482 .. tabs::
1483
1484    .. group-tab:: C++
1485
1486       .. doxygenclass:: simgrid::s4u::Link
1487       .. doxygenclass:: simgrid::s4u::SplitDuplexLink
1488       .. doxygenclass:: simgrid::s4u::LinkInRoute
1489
1490
1491    .. group-tab:: Python
1492
1493       .. autoclass:: simgrid.Link
1494
1495 Basic management
1496 ----------------
1497
1498 .. tabs::
1499
1500    .. group-tab:: C++
1501
1502       .. code-block:: C++
1503
1504          #include <simgrid/s4u/Link.hpp>
1505
1506       Note that there is no LinkPtr type and that you cannot use the RAII
1507       idiom on hosts because SimGrid does not allow (yet) to create nor
1508       destroy resources once the simulation is started.
1509
1510       .. doxygenfunction:: simgrid::s4u::Link::seal()
1511
1512    .. group-tab:: Python
1513
1514       .. code:: Python
1515
1516          from simgrid import Link
1517
1518       .. automethod:: simgrid.Link.seal
1519
1520    .. group-tab:: C
1521
1522       .. code:: C
1523
1524          #include <simgrid/link.h>
1525
1526       .. doxygentypedef:: sg_link_t
1527       .. cpp:type:: const s4u_Link* const_sg_link_t
1528
1529          Pointer to a constant link object.
1530
1531 Retrieving links
1532 ----------------
1533
1534 .. tabs::
1535
1536    .. group-tab:: C++
1537
1538       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1539
1540       .. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
1541       .. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1542
1543    .. group-tab:: Python
1544
1545       See also :py:func:`simgrid.Engine.get_all_links`.
1546
1547       .. automethod:: simgrid.Link.by_name
1548       .. autoattribute:: simgrid.Link.name
1549
1550    .. group-tab:: C
1551
1552       .. doxygenfunction:: sg_link_by_name(const char *name)
1553       .. doxygenfunction:: sg_link_count()
1554       .. doxygenfunction:: sg_link_list()
1555
1556 Querying info
1557 --------------
1558
1559 .. tabs::
1560
1561    .. group-tab:: C++
1562
1563       .. doxygenfunction:: simgrid::s4u::Link::get_bandwidth() const
1564       .. doxygenfunction:: simgrid::s4u::Link::get_cname() const
1565       .. doxygenfunction:: simgrid::s4u::Link::get_latency() const
1566       .. doxygenfunction:: simgrid::s4u::Link::get_name() const
1567       .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const
1568       .. doxygenfunction:: simgrid::s4u::Link::get_usage() const
1569       .. doxygenfunction:: simgrid::s4u::Link::is_used() const
1570
1571    .. group-tab:: Python
1572
1573       .. autoattribute:: simgrid.Link.bandwidth
1574       .. autoattribute:: simgrid.Link.latency
1575
1576    .. group-tab:: C
1577
1578       .. doxygenfunction:: sg_link_get_bandwidth(const_sg_link_t link)
1579       .. doxygenfunction:: sg_link_get_latency(const_sg_link_t link)
1580       .. doxygenfunction:: sg_link_get_name(const_sg_link_t link)
1581       .. doxygenfunction:: sg_link_is_shared(const_sg_link_t link)
1582
1583 Modifying characteristics
1584 -------------------------
1585
1586 .. tabs::
1587
1588    .. group-tab:: C++
1589
1590       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
1591       .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
1592       .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value)
1593       .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit)
1594       .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {})
1595
1596    .. group-tab:: Python
1597
1598       .. automethod:: simgrid.Link.set_bandwidth
1599       .. automethod:: simgrid.Link.set_latency
1600       .. automethod:: simgrid.Link.set_concurrency_limit
1601       .. automethod:: simgrid.Link.set_sharing_policy
1602
1603    .. group-tab:: C
1604
1605       .. doxygenfunction:: sg_link_set_bandwidth(sg_link_t link, double value)
1606       .. doxygenfunction:: sg_link_set_latency(sg_link_t link, double value)
1607
1608 User data and properties
1609 ------------------------
1610
1611 .. tabs::
1612
1613    .. group-tab:: C++
1614
1615       .. doxygenfunction:: simgrid::s4u::Link::get_property(const std::string &key) const
1616       .. doxygenfunction:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1617
1618    .. group-tab:: C
1619
1620       .. doxygenfunction:: sg_link_get_data(const_sg_link_t link)
1621       .. doxygenfunction:: sg_link_set_data(sg_link_t link, void *data)
1622
1623 On/Off
1624 ------
1625
1626 .. tabs::
1627
1628    .. group-tab:: C++
1629
1630       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1631
1632       .. doxygenfunction:: simgrid::s4u::Link::is_on() const
1633       .. doxygenfunction:: simgrid::s4u::Link::turn_off()
1634       .. doxygenfunction:: simgrid::s4u::Link::turn_on()
1635
1636    .. group-tab:: Python
1637
1638       See also :py:func:`simgrid.Link.set_state_profile`.
1639
1640       .. automethod:: simgrid.Link.is_on
1641       .. automethod:: simgrid.Link.turn_off
1642       .. automethod:: simgrid.Link.turn_on
1643
1644 Dynamic profiles
1645 ----------------
1646
1647 See :ref:`howto_churn` for more details.
1648
1649 .. tabs::
1650
1651    .. group-tab:: C++
1652
1653       .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1654       .. doxygenfunction:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1655       .. doxygenfunction:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1656
1657 WIFI links
1658 ----------
1659
1660 .. tabs::
1661
1662    .. group-tab:: C++
1663
1664       .. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
1665
1666    .. group-tab:: Python
1667
1668       .. automethod:: simgrid.Link.set_host_wifi_rate
1669
1670 Signals
1671 -------
1672
1673 .. tabs::
1674
1675    .. group-tab:: C++
1676
1677       .. doxygenfunction:: simgrid::s4u::Link::on_bandwidth_change_cb
1678       .. doxygenfunction:: simgrid::s4u::Link::on_communication_state_change_cb
1679       .. doxygenfunction:: simgrid::s4u::Link::on_creation_cb
1680       .. doxygenfunction:: simgrid::s4u::Link::on_destruction_cb
1681       .. doxygenfunction:: simgrid::s4u::Link::on_state_change_cb
1682
1683 .. _API_s4u_NetZone:
1684
1685 ================
1686 ⁣  class NetZone
1687 ================
1688
1689 .. tabs::
1690
1691    .. group-tab:: C++
1692
1693       .. doxygenclass:: simgrid::s4u::NetZone
1694
1695    .. group-tab:: Python
1696
1697       .. autoclass:: simgrid.NetZone
1698
1699 Basic management
1700 ----------------
1701
1702 .. tabs::
1703
1704    .. group-tab:: C++
1705
1706       .. code-block:: C++
1707
1708          #include <simgrid/s4u/NetZone.hpp>
1709
1710       Note that there is no NetZonePtr type and that you cannot use the RAII
1711       idiom on network zones because SimGrid does not allow (yet) to create nor
1712       destroy resources once the simulation is started.
1713
1714       .. doxygenfunction:: simgrid::s4u::NetZone::seal
1715
1716    .. group-tab:: Python
1717
1718       .. code:: Python
1719
1720          from simgrid import NetZone
1721
1722       .. automethod:: simgrid.NetZone.seal
1723
1724    .. group-tab:: C
1725
1726       .. code:: C
1727
1728          #include <simgrid/zone.h>
1729
1730       .. doxygentypedef:: sg_netzone_t
1731       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1732
1733          Pointer to a constant network zone object.
1734
1735 Retrieving zones
1736 ----------------
1737
1738 .. tabs::
1739
1740    .. group-tab:: C++
1741
1742       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1743       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1744       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1745
1746    .. group-tab:: C
1747
1748       .. doxygenfunction:: sg_zone_get_by_name(const char *name)
1749       .. doxygenfunction:: sg_zone_get_root()
1750
1751 Querying info
1752 --------------
1753
1754 .. tabs::
1755
1756    .. group-tab:: C++
1757
1758       .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
1759       .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
1760       .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint()
1761
1762    .. group-tab:: Python
1763
1764       .. autoattribute:: simgrid.NetZone.name
1765       .. automethod:: simgrid.NetZone.get_netpoint
1766
1767    .. group-tab:: C
1768
1769       .. doxygenfunction:: sg_zone_get_name(const_sg_netzone_t zone)
1770
1771 User data and properties
1772 ------------------------
1773
1774 .. tabs::
1775
1776    .. group-tab:: C++
1777
1778       .. doxygenfunction:: simgrid::s4u::NetZone::get_properties() const
1779       .. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1780       .. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1781
1782    .. group-tab:: Python
1783
1784       .. automethod:: simgrid.NetZone.set_property
1785
1786    .. group-tab:: C
1787
1788       .. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1789       .. doxygenfunction:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1790
1791 Retrieving components
1792 ---------------------
1793
1794 .. tabs::
1795
1796    .. group-tab:: C++
1797
1798       .. doxygenfunction:: simgrid::s4u::NetZone::get_all_hosts() const
1799       .. doxygenfunction:: simgrid::s4u::NetZone::get_host_count() const
1800
1801    .. group-tab:: C
1802
1803       .. doxygenfunction:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1804
1805 Routing data
1806 ------------
1807
1808 .. tabs::
1809
1810    .. group-tab:: C++
1811
1812       .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1813       .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1814       .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
1815       .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1816       .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
1817       .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent)
1818
1819    .. group-tab:: Python
1820
1821       .. automethod:: simgrid.NetZone.add_route
1822       .. automethod:: simgrid.NetZone.set_parent
1823
1824    .. group-tab:: C
1825
1826       .. doxygenfunction:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1827
1828 Signals
1829 -------
1830
1831 .. tabs::
1832
1833   .. group-tab:: C++
1834
1835      .. doxygenfunction:: simgrid::s4u::NetZone::on_creation_cb
1836      .. doxygenfunction:: simgrid::s4u::NetZone::on_seal_cb
1837
1838 Creating resources
1839 ------------------
1840
1841 Zones
1842 ^^^^^
1843 .. tabs::
1844
1845   .. group-tab:: C++
1846
1847      .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name)
1848      .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name)
1849      .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name)
1850      .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache)
1851      .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name)
1852      .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name)
1853      .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name)
1854      .. doxygenfunction:: simgrid::s4u::create_torus_zone
1855      .. doxygenfunction:: simgrid::s4u::create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
1856      .. doxygenfunction:: simgrid::s4u::create_dragonfly_zone(const std::string& name, const NetZone* parent, const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
1857
1858   .. group-tab:: Python
1859
1860      .. automethod:: simgrid.NetZone.create_full_zone
1861      .. automethod:: simgrid.NetZone.create_empty_zone
1862      .. automethod:: simgrid.NetZone.create_star_zone
1863      .. automethod:: simgrid.NetZone.create_dijkstra_zone
1864      .. automethod:: simgrid.NetZone.create_floyd_zone
1865      .. automethod:: simgrid.NetZone.create_vivaldi_zone
1866      .. automethod:: simgrid.NetZone.create_wifi_zone
1867      .. automethod:: simgrid.NetZone.create_torus_zone
1868      .. automethod:: simgrid.NetZone.create_fatTree_zone
1869      .. automethod:: simgrid.NetZone.create_dragonfly_zone
1870
1871 Hosts
1872 ^^^^^
1873
1874 .. tabs::
1875
1876   .. group-tab:: C++
1877
1878      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
1879      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed)
1880      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
1881      .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed)
1882
1883   .. group-tab:: Python
1884
1885      .. automethod:: simgrid.NetZone.create_host
1886
1887 Links
1888 ^^^^^
1889
1890 .. tabs::
1891
1892   .. group-tab:: C++
1893
1894      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
1895      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth)
1896      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidthds)
1897      .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth)
1898      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
1899      .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
1900
1901   .. group-tab:: Python
1902
1903      .. automethod:: simgrid.NetZone.create_link
1904      .. automethod:: simgrid.NetZone.create_split_duplex_link
1905
1906 Router
1907 ^^^^^^
1908
1909 .. tabs::
1910
1911   .. group-tab:: C++
1912
1913      .. doxygenfunction:: simgrid::s4u::NetZone::create_router(const std::string& name)
1914
1915   .. group-tab:: Python
1916
1917      .. automethod:: simgrid.NetZone.create_router
1918
1919 .. _API_s4u_VirtualMachine:
1920
1921 =======================
1922 ⁣  class VirtualMachine
1923 =======================
1924
1925
1926 .. doxygenclass:: simgrid::s4u::VirtualMachine
1927
1928 Basic management
1929 ----------------
1930 .. tabs::
1931
1932    .. group-tab:: C++
1933
1934       .. code-block:: C++
1935
1936          #include <simgrid/s4u/VirtualMachine.hpp>
1937
1938       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1939       idiom on virtual machines. There is no good reason for that and should change in the future.
1940
1941    .. group-tab:: C
1942
1943       .. code:: C
1944
1945          #include <simgrid/vm.h>
1946
1947       .. doxygentypedef:: sg_vm_t
1948       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1949
1950          Pointer to a constant virtual machine object.
1951
1952 Creating VMs
1953 ------------
1954
1955 .. tabs::
1956
1957    .. group-tab:: C++
1958
1959       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount)
1960       .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount, size_t ramsize)
1961       .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1962
1963    .. group-tab:: C
1964
1965       .. doxygenfunction:: sg_vm_create_core
1966       .. doxygenfunction:: sg_vm_create_multicore
1967       .. doxygenfunction:: sg_vm_destroy
1968
1969 Querying info
1970 --------------
1971
1972 .. tabs::
1973
1974    .. group-tab:: C++
1975
1976       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1977       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
1978       .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
1979
1980       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1981       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1982       .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1983
1984    .. group-tab:: C
1985
1986       .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
1987       .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
1988       .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1989
1990       .. doxygenfunction:: sg_vm_get_name
1991       .. doxygenfunction:: sg_vm_get_pm
1992       .. doxygenfunction:: sg_vm_is_created
1993       .. doxygenfunction:: sg_vm_is_running
1994       .. doxygenfunction:: sg_vm_is_suspended
1995
1996 Life cycle
1997 ----------
1998
1999 .. tabs::
2000
2001    .. group-tab:: C++
2002
2003       .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
2004       .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
2005       .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
2006       .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
2007
2008    .. group-tab:: C
2009
2010       .. doxygenfunction:: sg_vm_start
2011       .. doxygenfunction:: sg_vm_suspend
2012       .. doxygenfunction:: sg_vm_resume
2013       .. doxygenfunction:: sg_vm_shutdown
2014
2015 Signals
2016 -------
2017
2018 .. tabs::
2019
2020    .. group-tab:: C++
2021
2022       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_creation_cb
2023       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_destruction_cb
2024       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_migration_end_cb
2025       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_migration_start_cb
2026       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_resume_cb
2027       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_shutdown_cb
2028       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_start_cb
2029       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_started_cb
2030       .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_suspend_cb
2031
2032 .. _API_s4u_Activity:
2033
2034 ==========
2035 Activities
2036 ==========
2037
2038 ==============
2039 class Activity
2040 ==============
2041
2042 .. doxygenclass:: simgrid::s4u::Activity
2043
2044 **Known subclasses:**
2045 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
2046 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
2047 :ref:`I/O <API_s4u_Io>` (started on and consuming disks).
2048 See also the :ref:`section on activities <s4u_Activities>` above.
2049
2050 Basic management
2051 ----------------
2052
2053 .. tabs::
2054
2055    .. group-tab:: C++
2056
2057       .. code-block:: C++
2058
2059          #include <simgrid/s4u/Activity.hpp>
2060
2061       .. doxygentypedef:: ActivityPtr
2062
2063 Querying info
2064 -------------
2065
2066 .. tabs::
2067
2068    .. group-tab:: C++
2069
2070       .. doxygenfunction:: simgrid::s4u::Activity::get_cname
2071       .. doxygenfunction:: simgrid::s4u::Activity::get_name
2072       .. doxygenfunction:: simgrid::s4u::Activity::get_remaining() const
2073       .. doxygenfunction:: simgrid::s4u::Activity::get_state() const
2074       .. doxygenfunction:: simgrid::s4u::Activity::set_remaining(double remains)
2075       .. doxygenfunction:: simgrid::s4u::Activity::set_state(Activity::State state)
2076
2077
2078 Activities life cycle
2079 ---------------------
2080
2081 .. tabs::
2082
2083    .. group-tab:: C++
2084
2085       .. doxygenfunction:: simgrid::s4u::Activity::start
2086       .. doxygenfunction:: simgrid::s4u::Activity::cancel
2087       .. doxygenfunction:: simgrid::s4u::Activity::test
2088       .. doxygenfunction:: simgrid::s4u::Activity::wait
2089       .. doxygenfunction:: simgrid::s4u::Activity::wait_for
2090       .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit)
2091       .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start()
2092
2093 Suspending and resuming an activity
2094 -----------------------------------
2095
2096 .. tabs::
2097
2098    .. group-tab:: C++
2099
2100       .. doxygenfunction:: simgrid::s4u::Activity::suspend
2101       .. doxygenfunction:: simgrid::s4u::Activity::resume
2102       .. doxygenfunction:: simgrid::s4u::Activity::is_suspended
2103
2104 .. _API_s4u_Comm:
2105
2106 =============
2107 ⁣  class Comm
2108 =============
2109
2110 .. tabs::
2111
2112    .. group-tab:: C++
2113
2114       .. doxygenclass:: simgrid::s4u::Comm
2115
2116    .. group-tab:: Python
2117
2118       .. autoclass:: simgrid.Comm
2119
2120 Basic management
2121 ----------------
2122
2123 .. tabs::
2124
2125    .. group-tab:: C++
2126
2127       .. code-block:: C++
2128
2129          #include <simgrid/s4u/Comm.hpp>
2130
2131       .. doxygentypedef:: CommPtr
2132
2133    .. group-tab:: Python
2134
2135       .. code:: Python
2136
2137          from simgrid import Comm
2138
2139    .. group-tab:: c
2140
2141       .. code:: c
2142
2143          #include <simgrid/comm.h>
2144
2145       .. doxygentypedef:: sg_comm_t
2146       .. doxygentypedef:: const_sg_comm_t
2147
2148 Querying info
2149 -------------
2150
2151 .. tabs::
2152
2153    .. group-tab:: C++
2154
2155       .. doxygenfunction:: simgrid::s4u::Comm::get_dst_data_size() const
2156       .. doxygenfunction:: simgrid::s4u::Comm::get_mailbox() const
2157       .. doxygenfunction:: simgrid::s4u::Comm::get_sender() const
2158       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff)
2159       .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
2160       .. doxygenfunction:: simgrid::s4u::Comm::detach()
2161       .. doxygenfunction:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
2162       .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(uint64_t bytes)
2163       .. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
2164       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
2165       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
2166       .. doxygenfunction:: simgrid::s4u::Comm::set_src_data_size(size_t size)
2167
2168 Life cycle
2169 ----------
2170
2171 Most communications are created using :ref:`s4u_mailbox`, but you can
2172 also start direct communications as shown below.
2173
2174 .. tabs::
2175
2176    .. group-tab:: C++
2177
2178       .. doxygenfunction:: simgrid::s4u::Comm::sendto
2179       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init()
2180       .. doxygenfunction:: simgrid::s4u::Comm::sendto_init(Host *from, Host *to)
2181       .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
2182
2183       .. doxygenfunction:: simgrid::s4u::Comm::cancel
2184       .. doxygenfunction:: simgrid::s4u::Comm::start
2185       .. doxygenfunction:: simgrid::s4u::Comm::test
2186       .. doxygenfunction:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr >& comms)
2187       .. doxygenfunction:: simgrid::s4u::Comm::wait
2188       .. doxygenfunction:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr >& comms)
2189       .. doxygenfunction:: simgrid::s4u::Comm::wait_all_for(const std::vector< CommPtr >& comms, double timeout)
2190       .. doxygenfunction:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr >& comms)
2191       .. doxygenfunction:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr >& comms, double timeout)
2192       .. doxygenfunction:: simgrid::s4u::Comm::wait_for
2193
2194    .. group-tab:: Python
2195
2196       .. automethod:: simgrid.Comm.test
2197       .. automethod:: simgrid.Comm.wait
2198       .. automethod:: simgrid.Comm.wait_all
2199       .. automethod:: simgrid.Comm.wait_any
2200
2201    .. group-tab:: C
2202
2203       .. doxygenfunction:: sg_comm_test
2204       .. doxygenfunction:: sg_comm_wait
2205       .. doxygenfunction:: sg_comm_wait_all
2206       .. doxygenfunction:: sg_comm_wait_any
2207
2208 Signals
2209 -------
2210
2211 .. tabs::
2212
2213    .. group-tab:: C++
2214
2215       .. doxygenfunction:: simgrid::s4u::Comm::on_start_cb
2216       .. doxygenfunction:: simgrid::s4u::Comm::on_completion_cb
2217       .. doxygenfunction:: simgrid::s4u::Comm::on_recv_cb
2218       .. doxygenfunction:: simgrid::s4u::Comm::on_send_cb
2219
2220 .. _API_s4u_Exec:
2221
2222 =============
2223 ⁣  class Exec
2224 =============
2225
2226 .. tabs::
2227
2228    .. group-tab:: C++
2229
2230       .. doxygenclass:: simgrid::s4u::Exec
2231
2232    .. group-tab:: Python
2233
2234       .. autoclass:: simgrid.Exec
2235
2236 Basic management
2237 ----------------
2238
2239 .. tabs::
2240
2241    .. group-tab:: C++
2242
2243       .. code-block:: C++
2244
2245          #include <simgrid/s4u/Exec.hpp>
2246
2247       .. doxygentypedef:: ExecPtr
2248
2249    .. group-tab:: Python
2250
2251       .. code:: Python
2252
2253          from simgrid import Exec
2254
2255    .. group-tab:: C
2256
2257       .. code-block:: C
2258
2259          #include <simgrid/exec.h>
2260
2261       .. doxygentypedef:: sg_exec_t
2262       .. doxygentypedef:: const_sg_exec_t
2263
2264 Querying info
2265 -------------
2266
2267 .. tabs::
2268
2269    .. group-tab:: C++
2270
2271       .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
2272       .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
2273       .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
2274       .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
2275       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining
2276       .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
2277       .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
2278       .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
2279       .. doxygenfunction:: simgrid::s4u::Exec::set_host
2280       .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
2281
2282    .. group-tab:: Python
2283
2284       .. autoattribute:: simgrid.Exec.host
2285       .. autoattribute:: simgrid.Exec.remaining
2286       .. autoattribute:: simgrid.Exec.remaining_ratio
2287
2288    .. group-tab:: C
2289
2290       .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
2291       .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
2292       .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
2293       .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
2294       .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
2295       .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
2296
2297 Life cycle
2298 ----------
2299
2300 .. tabs::
2301
2302    .. group-tab:: C++
2303
2304       .. doxygenfunction:: simgrid::s4u::Exec::cancel
2305       .. doxygenfunction:: simgrid::s4u::Exec::start
2306       .. doxygenfunction:: simgrid::s4u::Exec::test
2307       .. doxygenfunction:: simgrid::s4u::Exec::wait
2308       .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2309       .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2310       .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2311
2312    .. group-tab:: Python
2313
2314        .. automethod:: simgrid.Exec.cancel
2315        .. automethod:: simgrid.Exec.start
2316        .. automethod:: simgrid.Exec.test
2317        .. automethod:: simgrid.Exec.wait
2318
2319    .. group-tab:: C
2320
2321        .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2322        .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2323        .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2324        .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2325        .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2326        .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2327        .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2328
2329 Signals
2330 -------
2331
2332 .. tabs::
2333
2334    .. group-tab:: C++
2335
2336       .. doxygenfunction:: simgrid::s4u::Exec::on_start_cb
2337       .. doxygenfunction:: simgrid::s4u::Exec::on_completion_cb
2338
2339 .. _API_s4u_Io:
2340
2341 ===========
2342 ⁣  class Io
2343 ===========
2344
2345 .. tabs::
2346
2347    .. group-tab:: C++
2348
2349       .. doxygenclass:: simgrid::s4u::Io
2350
2351    .. group-tab:: Python
2352
2353       .. autoclass:: simgrid.Io
2354
2355 Basic management
2356 ----------------
2357
2358 .. tabs::
2359
2360    .. group-tab:: C++
2361
2362       .. code-block:: C++
2363
2364          #include <simgrid/s4u/Io.hpp>
2365
2366       .. doxygentypedef:: IoPtr
2367
2368 Querying info
2369 -------------
2370
2371 .. tabs::
2372
2373    .. group-tab:: C++
2374
2375       .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2376       .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2377
2378 Life cycle
2379 ----------
2380
2381 .. tabs::
2382
2383    .. group-tab:: C++
2384
2385       .. doxygenfunction:: simgrid::s4u::Io::cancel
2386       .. doxygenfunction:: simgrid::s4u::Io::start
2387       .. doxygenfunction:: simgrid::s4u::Io::test
2388       .. doxygenfunction:: simgrid::s4u::Io::wait
2389       .. doxygenfunction:: simgrid::s4u::Io::wait_for
2390       .. doxygenfunction:: simgrid::s4u::Io::wait_any
2391       .. doxygenfunction:: simgrid::s4u::Io::wait_any_for
2392
2393    .. group-tab:: Python
2394
2395       .. automethod:: simgrid.Io.test
2396       .. automethod:: simgrid.Io.wait
2397       .. automethod:: simgrid.Io.wait_any_for
2398       .. automethod:: simgrid.Io.wait_any
2399
2400 Signals
2401 -------
2402
2403 .. tabs::
2404
2405    .. group-tab:: C++
2406
2407       .. doxygenfunction:: simgrid::s4u::Io::on_start_cb
2408       .. doxygenfunction:: simgrid::s4u::Io::on_completion_cb
2409
2410 .. _API_s4u_Synchronizations:
2411
2412 =======================
2413 Synchronization Objects
2414 =======================
2415
2416 .. _API_s4u_Mutex:
2417
2418 ==============
2419 ⁣  Mutex
2420 ==============
2421
2422 .. doxygenclass:: simgrid::s4u::Mutex
2423
2424 Basic management
2425 ----------------
2426
2427    .. tabs::
2428
2429       .. group-tab:: C++
2430
2431          .. code-block:: C++
2432
2433             #include <simgrid/s4u/Mutex.hpp>
2434
2435          .. doxygentypedef:: MutexPtr
2436
2437          .. doxygenfunction:: simgrid::s4u::Mutex::create()
2438
2439       .. group-tab:: C
2440
2441          .. code-block:: C
2442
2443             #include <simgrid/mutex.h>
2444
2445          .. doxygentypedef:: sg_mutex_t
2446          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2447
2448             Pointer to a constant mutex object.
2449
2450          .. doxygenfunction:: sg_mutex_init()
2451          .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2452
2453 Locking
2454 -------
2455
2456    .. tabs::
2457
2458       .. group-tab:: C++
2459
2460          .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2461          .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2462          .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2463
2464       .. group-tab:: C
2465
2466          .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2467          .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2468          .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2469
2470 .. _API_s4u_Barrier:
2471
2472 ================
2473 ⁣  Barrier
2474 ================
2475
2476 .. doxygenclass:: simgrid::s4u::Barrier
2477
2478 .. tabs::
2479
2480    .. group-tab:: C++
2481
2482       .. code-block:: C++
2483
2484          #include <simgrid/s4u/Barrier.hpp>
2485
2486       .. doxygentypedef:: BarrierPtr
2487
2488       .. doxygenfunction:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2489       .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2490       .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2491
2492    .. group-tab:: C
2493
2494       .. code-block:: C
2495
2496          #include <simgrid/barrier.hpp>
2497
2498       .. doxygentypedef:: sg_bar_t
2499       .. doxygentypedef:: const_sg_bar_t
2500       .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2501
2502          Pointer to a constant barrier object.
2503
2504       .. doxygenfunction:: sg_barrier_init(unsigned int count)
2505       .. doxygenfunction:: sg_barrier_destroy(const_sg_bar_t bar)
2506       .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2507
2508
2509 .. _API_s4u_ConditionVariable:
2510
2511 ==========================
2512 ⁣  Condition variable
2513 ==========================
2514
2515 .. doxygenclass:: simgrid::s4u::ConditionVariable
2516
2517 Basic management
2518 ----------------
2519
2520    .. tabs::
2521
2522       .. group-tab:: C++
2523
2524          .. code-block:: C++
2525
2526             #include <simgrid/s4u/ConditionVariable.hpp>
2527
2528          .. doxygentypedef:: ConditionVariablePtr
2529
2530          .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2531
2532       .. group-tab:: C
2533
2534          .. code-block:: C
2535
2536             #include <simgrid/cond.h>
2537
2538          .. doxygentypedef:: sg_cond_t
2539          .. doxygentypedef:: const_sg_cond_t
2540          .. doxygenfunction:: sg_cond_init
2541          .. doxygenfunction:: sg_cond_destroy
2542
2543 Waiting and notifying
2544 ---------------------
2545
2546    .. tabs::
2547
2548       .. group-tab:: C++
2549
2550          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2551          .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2552          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2553          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2554          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2555          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2556          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2557          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2558          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2559          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2560          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2561          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2562          .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2563
2564       .. group-tab:: C
2565
2566          .. doxygenfunction:: sg_cond_notify_all
2567          .. doxygenfunction:: sg_cond_notify_one
2568          .. doxygenfunction:: sg_cond_wait
2569          .. doxygenfunction:: sg_cond_wait_for
2570
2571 .. _API_s4u_Semaphore:
2572
2573 ==================
2574 ⁣  Semaphore
2575 ==================
2576
2577 .. doxygenclass:: simgrid::s4u::Semaphore
2578
2579
2580 Basic management
2581 ----------------
2582
2583    .. tabs::
2584
2585       .. group-tab:: C++
2586
2587          .. code-block:: C++
2588
2589             #include <simgrid/s4u/Semaphore.hpp>
2590
2591          .. doxygentypedef:: SemaphorePtr
2592          .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2593
2594       .. group-tab:: C
2595
2596          .. code-block:: C
2597
2598             #include <simgrid/semaphore.h>
2599
2600          .. doxygentypedef:: sg_sem_t
2601          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2602
2603             Pointer to a constant semaphore object.
2604
2605          .. doxygenfunction:: sg_sem_init(int initial_value)
2606          .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2607
2608 Locking
2609 -------
2610
2611    .. tabs::
2612
2613       .. group-tab:: C++
2614
2615          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2616          .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2617          .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2618          .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2619          .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2620
2621       .. group-tab:: C
2622
2623          .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2624          .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2625          .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2626          .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2627          .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)
2628
2629 .. |hr| raw:: html
2630
2631    <hr />