docs/source/app_s4u.rst

   1 .. _S4U_doc:
   2
   3 The S4U Interface
   4 #################
   5
   6 .. raw:: html
   7
   8    <object id="TOC" data="graphical-toc.svg" type="image/svg+xml"></object>
   9    <script>
  10    window.onload=function() { // Wait for the SVG to be loaded before changing it
  11      var elem=document.querySelector("#TOC").contentDocument.getElementById("ActorBox")
  12      elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
  13    }
  14    </script>
  15    <br/>
  16    <br/>
  17
  18 The S4U interface (SimGrid for you) mixes the full power of SimGrid
  19 with the full power of C++. This is the preferred interface to describe
  20 abstract algorithms in the domains of Cloud, P2P, HPC, IoT, and similar
  21 settings.
  22
  23 Since v3.20 (June 2018), S4U is definitely the way to go for long-term
  24 projects. It is feature complete, but may still evolve slightly in the
  25 future releases. It can already be used to do everything that can be
  26 done in SimGrid, but you may have to adapt your code in future
  27 releases. When this happens, compiling your code will produce
  28 deprecation warnings for 4 releases (one year) before the removal of
  29 the old symbols.
  30 If you want an API that will never ever evolve in the future, you
  31 should use the :ref:`deprecated MSG API <MSG_doc>` instead.
  32
  33 Main Concepts
  34 *************
  35
  36 A typical SimGrid simulation is composed of several |API_s4u_Actors|_, that
  37 execute user-provided functions. The actors have to explicitly use the
  38 S4U interface to express their :ref:`computation <API_s4u_Exec>`,
  39 :ref:`communication <API_s4u_Comm>`, :ref:`disk usage <API_s4u_Io>`,
  40 and other |API_s4u_Activities|_, so that they get reflected within the
  41 simulator. These activities take place on resources such as |API_s4u_Hosts|_,
  42 |API_s4u_Links|_ and |API_s4u_Disks|_. SimGrid predicts the time taken by each
  43 activity and orchestrates the actors accordingly, waiting for the
  44 completion of these activities.
  45
  46
  47 When **communicating**, data is not directly sent to other actors but
  48 posted onto a |API_s4u_Mailbox|_ that serves as a rendez-vous point between
  49 communicating actors. This means that you don't need to know who you
  50 are talking to, you just put your communication `Put` request in a
  51 mailbox, and it will be matched with a complementary `Get`
  52 request.  Alternatively, actors can interact through **classical
  53 synchronization mechanisms** such as |API_s4u_Barrier|_, |API_s4u_Semaphore|_,
  54 |API_s4u_Mutex|_ and |API_s4u_ConditionVariable|_.
  55
  56 Each actor is located on a simulated |API_s4u_Host|_. Each host is located
  57 itself in a |API_s4u_NetZone|_, that knows the networking path between one
  58 resource to another. Each NetZone is included in another one, forming
  59 a tree of NetZones which root zone contains the whole platform. The
  60 actors can also be located on a |API_s4U_VirtualMachine|_ that may
  61 restrict the activities it contains to a limited amount of cores.
  62 Virtual machines can also be migrated between hosts.
  63
  64 The :ref:`simgrid::s4u::this_actor <API_s4u_this_actor>` namespace
  65 provides many helper functions to simplify the code of actors.
  66
  67 - **Simulation Elements**
  68
  69   - :ref:`class Actor <API_s4u_Actor>`:
  70     Active entities executing your application.
  71   - :ref:`class Engine <API_s4u_Engine>`
  72     Simulation engine (singleton).
  73   - :ref:`class Mailbox <API_s4u_Mailbox>`
  74     Communication rendez-vous, with which actors meet each other.
  75
  76 - **Resources**
  77
  78   - :ref:`class Disk <API_s4u_Disk>`
  79     Resource on which actors can write and read data.
  80   - :ref:`class Host <API_s4u_Host>`:
  81     Actor location, providing computational power.
  82   - :ref:`class Link <API_s4u_Link>`
  83     Interconnecting hosts.
  84   - :ref:`class NetZone <API_s4u_NetZone>`:
  85     Sub-region of the platform, containing resources (Hosts, Links, etc).
  86   - :ref:`class VirtualMachine <API_s4u_VirtualMachine>`:
  87     Execution containers that can be moved between Hosts.
  88
  89 - **Activities** (:ref:`class Activity <API_s4u_Activity>`):
  90   The things that actors can do on resources
  91
  92   - :ref:`class Comm <API_s4u_Comm>`
  93     Communication activity, started on Mailboxes and consuming links.
  94   - :ref:`class Exec <API_s4u_Exec>`
  95     Computation activity, started on Host and consuming CPU resources.
  96   - :ref:`class Io <API_s4u_Io>`
  97     I/O activity, started on and consumming disks.
  98
  99 - **Synchronization Objects**: Classical IPC that actors can use
 100
 101   - :ref:`class Barrier <API_s4u_Barrier>`
 102   - :ref:`class ConditionVariable <API_s4u_ConditionVariable>`
 103   - :ref:`class Mutex <API_s4u_Mutex>`
 104   - :ref:`class Semaphore <API_s4u_Semaphore>`
 105
 106
 107 .. |API_s4u_Actors| replace:: **Actors**
 108 .. _API_s4u_Actors: #api-s4u-actor
 109
 110 .. |API_s4u_Activities| replace:: **Activities**
 111 .. _API_s4u_Activities: #api-s4u-activity
 112
 113 .. |API_s4u_Hosts| replace:: **Hosts**
 114 .. _API_s4u_Hosts: #api-s4u-host
 115
 116 .. |API_s4u_Links| replace:: **Links**
 117 .. _API_s4u_Links: #api-s4u-link
 118
 119 .. |API_s4u_Disks| replace:: **Disks**
 120 .. _API_s4u_Disks: #api-s4u-disk
 121
 122 .. |API_s4u_VirtualMachine| replace:: **VirtualMachines**
 123
 124 .. |API_s4u_Host| replace:: **Host**
 125
 126 .. |API_s4u_Mailbox| replace:: **Mailbox**
 127
 128 .. |API_s4u_Mailboxes| replace:: **Mailboxes**
 129 .. _API_s4u_Mailboxes: #s4u-mailbox
 130
 131 .. |API_s4u_NetZone| replace:: **NetZone**
 132
 133 .. |API_s4u_Barrier| replace:: **Barrier**
 134
 135 .. |API_s4u_Semaphore| replace:: **Semaphore**
 136
 137 .. |API_s4u_ConditionVariable| replace:: **ConditionVariable**
 138
 139 .. |API_s4u_Mutex| replace:: **Mutex**
 140
 141 .. _s4u_Activities:
 142
 143 Activities
 144 **********
 145
 146 Activities represent the actions that consume a resource, such as a
 147 :ref:`Comm <API_s4u_Comm>` that consumes the *transmitting power* of
 148 :ref:`Link <API_s4u_Link>` resources, or an :ref:`Exec <API_s4u_Exec>`
 149 that consumes the *computing power* of :ref:`Host <API_s4u_Host>` resources.
 150 See also the :ref:`full API <API_s4u_Activity>` below.
 151
 152 =======================
 153 Asynchronous Activities
 154 =======================
 155
 156 Every activity can be either **blocking** or **asynchronous**. For
 157 example, :cpp:func:`s4u::Mailbox::put() <simgrid::s4u::Mailbox::put>`
 158 and :cpp:func:`s4u::Mailbox::get() <simgrid::s4u::Mailbox::get>`
 159 create blocking communications: the actor is blocked until the
 160 completion of that communication. Asynchronous communications do not
 161 block the actor during their execution but progress on their own.
 162
 163 Once your asynchronous activity is started, you can test for its
 164 completion using :cpp:func:`s4u::Activity::test() <simgrid::s4u::Activity::test>`.
 165 This function returns ``true`` if the activity completed already.
 166 You can also use :cpp:func:`s4u::Activity::wait() <simgrid::s4u::Activity::wait>`
 167 to block until the completion of the activity. To wait for at most a given amount of time,
 168 use  :cpp:func:`s4u::Activity::wait_for() <simgrid::s4u::Activity::wait_for>`.
 169 Finally, to wait at most until a specified time limit, use
 170 :cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
 171
 172 .. todo::
 173
 174    wait_for and wait_until are currently not implemented for Exec and Io activities.
 175
 176 Every kind of activity can be asynchronous:
 177
 178   - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
 179     :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
 180     :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`.
 181   - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
 182     :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
 183     :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`.
 184   - :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
 185     :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
 186   - In the future, it will become possible to have asynchronous IPC
 187     such as asynchronous mutex lock requests.
 188
 189 The following example shows how to have several concurrent
 190 communications ongoing.  First, you have to declare a vector in which
 191 we will store the ongoing communications. It is also useful to have a
 192 vector of mailboxes.
 193
 194 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
 195    :language: c++
 196    :start-after: init-begin
 197    :end-before: init-end
 198    :dedent: 4
 199
 200 Then, you start all the communications that should occur concurrently with
 201 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
 202 Finally, the actor waits for the completion of all of them at once
 203 with
 204 :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
 205
 206 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
 207    :language: c++
 208    :start-after: put-begin
 209    :end-before: put-end
 210    :dedent: 4
 211
 212
 213 =====================
 214 Activities Life cycle
 215 =====================
 216
 217 Sometimes, you want to change the setting of an activity before it even starts.
 218
 219 .. todo:: write this section
 220
 221 .. _s4u_mailbox:
 222
 223 Mailboxes
 224 *********
 225
 226 Please also refer to the :ref:`API reference for s4u::Mailbox
 227 <API_s4u_Mailbox>`.
 228
 229 ===================
 230 What are Mailboxes?
 231 ===================
 232
 233 |API_s4u_Mailboxes|_ are rendez-vous points for network communications,
 234 similar to URLs on which you could post and retrieve data. Actually,
 235 the mailboxes are not involved in the communication once it starts,
 236 but only to find the contact with which you want to communicate.
 237
 238 They are similar to many common things: The phone number, which allows
 239 the caller to find the receiver. The twitter hashtag, which help
 240 senders and receivers to find each others. In TCP, the pair
 241 ``{host name, host port}`` to which you can connect to find your peer.
 242 In HTTP, URLs through which the clients can connect to the servers.
 243 In ZeroMQ, the queues are used to match senders and receivers.
 244
 245 One big difference with most of these systems is that no actor is the
 246 exclusive owner of a mailbox, neither in sending nor in receiving.
 247 Many actors can send into and/or receive from the same mailbox.  TCP
 248 socket ports for example are shared on the sender side but exclusive
 249 on the receiver side (only one process can receive from a given socket
 250 at a given point of time).
 251
 252 A big difference with TCP sockets or MPI communications is that
 253 communications do not start right away after a
 254 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put()>`, but wait
 255 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get()>`.
 256 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
 257
 258 A big difference with twitter hashtags is that SimGrid does not
 259 offer easy support to broadcast a given message to many
 260 receivers. So that would be like a twitter tag where each message
 261 is consumed by the first receiver.
 262
 263 A big difference with the ZeroMQ queues is that you cannot filter
 264 on the data you want to get from the mailbox. To model such settings
 265 in SimGrid, you'd have one mailbox per potential topic, and subscribe
 266 to each topic individually with a
 267 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async()>` on each mailbox.
 268 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any()>`
 269 to get the first message on any of the mailbox you are subscribed onto.
 270
 271 The mailboxes are not located on the network, and you can access
 272 them without any latency. The network delay are only related to the
 273 location of the sender and receiver once the match between them is
 274 done on the mailbox. This is just like the phone number that you
 275 can use locally, and the geographical distance only comes into play
 276 once you start the communication by dialing this number.
 277
 278 =====================
 279 How to use Mailboxes?
 280 =====================
 281
 282 You can retrieve any existing mailbox from its name (which is a
 283 unique string, just like a twitter tag). This results in a
 284 versatile mechanism that can be used to build many different
 285 situations.
 286
 287 To model classical socket communications, use "hostname:port" as
 288 mailbox names, and make sure that only one actor reads into a given
 289 mailbox. This does not make it easy to build a perfectly realistic
 290 model of the TCP sockets, but in most cases, this system is too
 291 cumbersome for your simulations anyway. You probably want something
 292 simpler, that turns our to be easy to build with the mailboxes.
 293
 294 Many SimGrid examples use a sort of yellow page system where the
 295 mailbox names are the name of the service (such as "worker",
 296 "master" or "reducer"). That way, you don't have to know where your
 297 peer is located to contact it. You don't even need its name. Its
 298 function is enough for that. This also gives you some sort of load
 299 balancing for free if more than one actor pulls from the mailbox:
 300 the first actor that can deal with the request will handle it.
 301
 302 =========================================
 303 How are put() and get() requests matched?
 304 =========================================
 305
 306 The matching algorithm simple: first come, first serve. When a new
 307 send arrives, it matches the oldest enqueued receive. If no receive is
 308 currently enqueued, then the incoming send is enqueued. As you can
 309 see, the mailbox cannot contain both send and receive requests: all
 310 enqueued requests must be of the same sort.
 311
 312 .. _s4u_receiving_actor:
 313
 314 ===========================
 315 Declaring a Receiving Actor
 316 ===========================
 317
 318 The last twist is that by default in the simulator, the data starts
 319 to be exchanged only when both the sender and the receiver are
 320 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 321 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
 322 In TCP, since you establish connections beforehand, the data starts to
 323 flow as soon as the sender posts it, even if the receiver did not post
 324 its :cpp:func:`recv() <simgrid::s4u::Mailbox::recv()>` yet.
 325
 326 To model this in SimGrid, you can declare a specific receiver to a
 327 given mailbox (with the function
 328 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
 329 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 330 posted to that mailbox will start as soon as possible, and the data
 331 will already be there on the receiver host when the receiver actor
 332 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
 333
 334 Note that being permanent receivers of a mailbox prevents actors to be
 335 garbage-collected. If your simulation creates many short-lived actors
 336 that marked as permanent receiver, you should call
 337 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
 338 memory gets properly reclaimed. This call should be at the end of the
 339 actor's function, not in a on_exit callback.
 340
 341 .. _s4u_raii:
 342
 343 Memory Management
 344 *****************
 345
 346 For sake of simplicity, we use `RAII
 347 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 348 for many classes in S4U. This is an idiom where resources are automatically
 349 managed through the context. Provided that you never manipulate
 350 objects of type Foo directly but always FooPtr references (which are
 351 defined as `boost::intrusive_ptr
 352 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 353 <Foo>), you will never have to explicitly release the resource that
 354 you use nor to free the memory of unused objects.
 355 Here is a little example:
 356
 357 .. code-block:: cpp
 358
 359    void myFunc()
 360    {
 361      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 362
 363      mutex->lock();   // use the mutex as a simple reference
 364      //  bla bla
 365      mutex->unlock();
 366
 367    } // The mutex gets automatically freed because the only existing reference gets out of scope
 368
 369 Note that Mailboxes, Hosts and Links are not handled thought smart
 370 pointers (yet?). This means that it is currently impossible to destroy a
 371 mailbox or a link. You can still destroy an host (but probably
 372 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 373
 374 .. THE EXAMPLES
 375
 376 .. include:: ../../examples/README.rst
 377
 378 API Reference
 379 *************
 380
 381 .. _API_s4u_simulation_object:
 382
 383 ==================
 384 Simulation objects
 385 ==================
 386
 387 .. _API_s4u_Actor:
 388
 389 ==============
 390 ⁣  class Actor
 391 ==============
 392
 393 .. autodoxyclass:: simgrid::s4u::Actor
 394
 395 .. doxygentypedef:: aid_t
 396
 397 Basic management
 398 ----------------
 399
 400 .. tabs::
 401
 402    .. group-tab:: C++
 403
 404       .. code:: C++
 405
 406          #include <simgrid/s4u/Actor.hpp>
 407
 408       .. doxygentypedef:: ActorPtr
 409
 410    .. group-tab:: Python
 411
 412       .. code:: Python
 413
 414          from simgrid import Actor
 415
 416    .. group-tab:: C
 417
 418       .. code:: C
 419
 420          #include <simgrid/actor.h>
 421
 422       .. doxygentypedef:: sg_actor_t
 423       .. cpp:type:: const s4u_Actor* const_sg_actor_t
 424
 425          Pointer to a constant actor object.
 426
 427       .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
 428       .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
 429
 430 Creating actors
 431 ---------------
 432
 433 .. tabs::
 434
 435    .. group-tab:: C++
 436
 437       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 438       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 439       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 440       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 441
 442       .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 443       .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 444
 445    .. group-tab:: Python
 446
 447       .. automethod:: simgrid.Actor.create
 448
 449    .. group-tab:: C
 450
 451       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
 452       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
 453
 454       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 455       .. autodoxymethod:: sg_actor_detach()
 456
 457 Retrieving actors
 458 -----------------
 459
 460 .. tabs::
 461
 462    .. group-tab:: C++
 463
 464       .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 465       .. autodoxymethod:: simgrid::s4u::Actor::self()
 466
 467    .. group-tab:: Python
 468
 469       .. automethod:: simgrid.Actor.by_pid
 470       .. automethod:: simgrid.Actor.self
 471
 472    .. group-tab:: C
 473
 474       .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
 475       .. autodoxymethod:: sg_actor_self()
 476
 477 Querying info
 478 -------------
 479
 480 .. tabs::
 481
 482    .. group-tab:: C++
 483
 484       .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 485       .. autodoxymethod:: simgrid::s4u::Actor::get_name
 486       .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 487       .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 488       .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 489       .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 490       .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 491
 492       .. autodoxymethod:: simgrid::s4u::Actor::get_host
 493       .. autodoxymethod:: simgrid::s4u::Actor::set_host
 494
 495       .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
 496       .. autodoxymethod:: simgrid::s4u::Actor::get_impl
 497
 498    .. group-tab:: Python
 499
 500       .. autoattribute:: simgrid.Actor.name
 501       .. autoattribute:: simgrid.Actor.host
 502       .. autoattribute:: simgrid.Actor.pid
 503       .. autoattribute:: simgrid.Actor.ppid
 504
 505    .. group-tab:: C
 506
 507       .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
 508       .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
 509       .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
 510       .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
 511       .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 512
 513       .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
 514       .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 515
 516       .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor)
 517       .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata)
 518
 519 Suspending and resuming actors
 520 ------------------------------
 521
 522 .. tabs::
 523
 524    .. group-tab:: C++
 525
 526       .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 527       .. autodoxymethod:: simgrid::s4u::Actor::resume()
 528       .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
 529
 530    .. group-tab:: Python
 531
 532       .. automethod:: simgrid.Actor.resume
 533       .. automethod:: simgrid.Actor.suspend
 534       .. automethod:: simgrid.Actor.is_suspended
 535
 536    .. group-tab:: C
 537
 538       .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
 539       .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
 540       .. autodoxymethod:: sg_actor_is_suspended(sg_actor_t actor)
 541
 542 Specifying when actors should terminate
 543 ---------------------------------------
 544
 545 .. tabs::
 546
 547    .. group-tab:: C++
 548
 549       .. autodoxymethod:: simgrid::s4u::Actor::kill()
 550       .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 551       .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 552       .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
 553
 554       .. autodoxymethod:: simgrid::s4u::Actor::restart()
 555       .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 556       .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 557
 558    .. group-tab:: Python
 559
 560       .. automethod:: simgrid.Actor.kill
 561       .. automethod:: simgrid.Actor.kill_all
 562
 563       .. automethod:: simgrid.Actor.daemonize
 564       .. automethod:: simgrid.Actor.is_daemon
 565
 566    .. group-tab:: C
 567
 568       .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
 569       .. autodoxymethod:: sg_actor_kill_all()
 570       .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 571
 572       .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
 573       .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
 574
 575 .. _API_s4u_Actor_end:
 576
 577 Reacting to the end of actors
 578 -----------------------------
 579
 580 .. tabs::
 581
 582    .. group-tab:: C++
 583
 584       .. autodoxymethod:: simgrid::s4u::Actor::on_exit
 585       .. autodoxymethod:: simgrid::s4u::Actor::join()
 586       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
 587       .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 588
 589    .. group-tab:: Python
 590
 591       .. automethod:: simgrid.Actor.join
 592
 593    .. group-tab:: C
 594
 595       .. autodoxymethod:: sg_actor_join(sg_actor_t actor, double timeout)
 596       .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 597
 598 Signals
 599 -------
 600
 601 .. tabs::
 602
 603    .. group-tab:: C++
 604
 605       .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 606       .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 607       .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 608       .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 609       .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 610       .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 611       .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 612
 613 .. _API_s4u_this_actor:
 614
 615 ====================
 616 ⁣  The current actor
 617 ====================
 618
 619 These functions can be used in your user code to interact with the actor
 620 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 621 Using these functions can greatly improve the code readability.
 622
 623 Querying info
 624 -------------
 625
 626 .. tabs::
 627
 628    .. group-tab:: C++
 629
 630       .. autodoxymethod:: simgrid::s4u::this_actor::get_cname()
 631       .. autodoxymethod:: simgrid::s4u::this_actor::get_name()
 632       .. autodoxymethod:: simgrid::s4u::this_actor::get_pid()
 633       .. autodoxymethod:: simgrid::s4u::this_actor::get_ppid()
 634       .. autodoxymethod:: simgrid::s4u::this_actor::is_maestro()
 635
 636       .. autodoxymethod:: simgrid::s4u::this_actor::get_host()
 637       .. autodoxymethod:: simgrid::s4u::this_actor::set_host(Host *new_host)
 638
 639    .. group-tab:: Python
 640
 641       .. autofunction:: simgrid.this_actor.get_host
 642       .. autofunction:: simgrid.this_actor.set_host
 643
 644    .. group-tab:: C
 645
 646       .. autodoxymethod:: sg_actor_self_data()
 647       .. autodoxymethod:: sg_actor_self_data_set(void *data)
 648       .. autodoxymethod:: sg_actor_self_get_name()
 649       .. autodoxymethod:: sg_actor_self_get_pid()
 650       .. autodoxymethod:: sg_actor_self_get_ppid()
 651       .. autodoxymethod:: sg_host_self()
 652       .. autodoxymethod:: sg_host_self_get_name()
 653
 654 Suspending and resuming
 655 -----------------------
 656
 657 .. tabs::
 658
 659    .. group-tab:: C++
 660
 661       .. autodoxymethod:: simgrid::s4u::this_actor::suspend()
 662       .. autodoxymethod:: simgrid::s4u::this_actor::yield()
 663
 664    .. group-tab:: Python
 665
 666       .. autofunction:: simgrid.this_actor.suspend
 667       .. autofunction:: simgrid.this_actor.yield_
 668
 669 Logging messages
 670 ----------------
 671
 672 .. tabs::
 673
 674    .. group-tab:: Python
 675
 676        .. autofunction:: simgrid.this_actor.info
 677        .. autofunction:: simgrid.this_actor.error
 678
 679 Sleeping
 680 --------
 681
 682 .. tabs::
 683
 684    .. group-tab:: C++
 685
 686       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(double duration)
 687       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
 688       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
 689       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
 690
 691    .. group-tab:: Python
 692
 693       .. autofunction:: simgrid.this_actor.sleep_for
 694       .. autofunction:: simgrid.this_actor.sleep_until
 695
 696    .. group-tab:: C
 697
 698       .. autodoxymethod:: sg_actor_sleep_for(double duration)
 699
 700 Simulating executions
 701 ---------------------
 702
 703 Simulate the execution of some code on this actor. You can either simulate
 704 parallel or sequential code, and you can either block upon the termination of
 705 the execution, or start an asynchronous activity.
 706
 707 .. tabs::
 708
 709    .. group-tab:: C++
 710
 711       .. autodoxymethod:: simgrid::s4u::this_actor::exec_async(double flops_amounts)
 712       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 713       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
 714       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
 715       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
 716       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 717       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
 718
 719    .. group-tab:: Python
 720
 721       .. autofunction:: simgrid.this_actor.exec_init
 722       .. autofunction:: simgrid.this_actor.execute
 723
 724    .. group-tab:: C
 725
 726       .. autodoxymethod:: sg_actor_self_execute(double flops)
 727
 728 Exiting
 729 -------
 730
 731 .. tabs::
 732
 733    .. group-tab:: C++
 734
 735       .. autodoxymethod:: simgrid::s4u::this_actor::exit()
 736       .. autodoxymethod:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 737
 738    .. group-tab:: Python
 739
 740       .. autofunction:: simgrid.this_actor.exit
 741       .. autofunction:: simgrid.this_actor.on_exit
 742
 743 .. _API_s4u_Engine:
 744
 745 ====================
 746 ⁣  Simulation Engine
 747 ====================
 748
 749 .. autodoxyclass:: simgrid::s4u::Engine
 750
 751 Initialization
 752 --------------
 753
 754 .. tabs::
 755
 756    .. group-tab:: C++
 757
 758       .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 759       .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
 760       .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
 761       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
 762
 763       .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
 764       .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
 765       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
 766       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 767       .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
 768       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
 769       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
 770
 771    .. group-tab:: Python
 772
 773        .. automethod:: simgrid.Engine.load_deployment
 774        .. automethod:: simgrid.Engine.load_platform
 775        .. automethod:: simgrid.Engine.register_actor
 776
 777    .. group-tab:: C
 778
 779       .. autodoxymethod:: simgrid_init
 780
 781       .. autodoxymethod:: simgrid_load_deployment
 782       .. autodoxymethod:: simgrid_load_platform
 783       .. autodoxymethod:: simgrid_register_default
 784       .. autodoxymethod:: simgrid_register_function
 785
 786 Run the simulation
 787 ------------------
 788
 789 .. tabs::
 790
 791    .. group-tab:: C++
 792
 793       .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
 794       .. autodoxymethod:: simgrid::s4u::Engine::run()
 795
 796    .. group-tab:: Python
 797
 798       .. automethod:: simgrid.Engine.get_clock
 799       .. automethod:: simgrid.Engine.run
 800
 801    .. group-tab:: C
 802
 803       .. autodoxymethod:: simgrid_get_clock
 804       .. autodoxymethod:: simgrid_run
 805
 806 Retrieving actors
 807 -----------------
 808
 809 .. tabs::
 810
 811    .. group-tab:: C++
 812
 813       .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
 814       .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
 815       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
 816
 817    .. group-tab:: C
 818
 819       .. autodoxymethod:: simgrid_get_actor_count()
 820
 821 Retrieving hosts
 822 ----------------
 823
 824 .. tabs::
 825
 826    .. group-tab:: C++
 827
 828       .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
 829       .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
 830       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
 831       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
 832       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
 833
 834    .. group-tab:: Python
 835
 836       .. automethod:: simgrid.Engine.get_all_hosts
 837
 838    .. group-tab:: C
 839
 840       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 841
 842 Retrieving links
 843 ----------------
 844
 845 .. tabs::
 846
 847    .. group-tab:: C++
 848
 849       .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
 850       .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
 851       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
 852       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
 853       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
 854
 855 Interacting with the routing
 856 ----------------------------
 857
 858 .. tabs::
 859
 860    .. group-tab:: C++
 861
 862       .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
 863       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
 864       .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
 865       .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
 866       .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
 867       .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
 868       .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 869
 870 Signals
 871 -------
 872
 873 .. tabs::
 874
 875    .. group-tab:: C++
 876
 877       .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
 878       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
 879       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
 880       .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
 881       .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
 882
 883 .. _API_s4u_Mailbox:
 884
 885 ================
 886 ⁣  class Mailbox
 887 ================
 888
 889 .. autodoxyclass:: simgrid::s4u::Mailbox
 890
 891 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 892
 893 Basic management
 894 ----------------
 895
 896 .. tabs::
 897
 898    .. group-tab:: C++
 899
 900       .. code-block:: C++
 901
 902          #include <simgrid/s4u/Mailbox.hpp>
 903
 904       Note that there is no MailboxPtr type, and that you cannot use the RAII
 905       idiom on mailboxes because they are internal objects to the simulation
 906       engine. Once created, there is no way to destroy a mailbox before the end
 907       of the simulation.
 908
 909       .. autodoxymethod:: simgrid::s4u::Mailbox::by_name(const std::string &name)
 910
 911    .. group-tab:: Python
 912
 913       .. automethod:: simgrid.Mailbox.by_name
 914
 915 Querying info
 916 -------------
 917
 918 .. tabs::
 919
 920    .. group-tab:: C++
 921
 922       .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname()
 923       .. autodoxymethod:: simgrid::s4u::Mailbox::get_name()
 924
 925    .. group-tab:: Python
 926
 927       .. autoattribute:: simgrid.Mailbox.name
 928
 929 Sending data
 930 ------------
 931
 932 .. tabs::
 933
 934    .. group-tab:: C++
 935
 936       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
 937       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
 938       .. autodoxymethod:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
 939       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init()
 940       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
 941
 942    .. group-tab:: Python
 943
 944       .. automethod:: simgrid.Mailbox.put
 945       .. automethod:: simgrid.Mailbox.put_async
 946
 947
 948 Receiving data
 949 --------------
 950
 951 .. tabs::
 952
 953    .. group-tab:: C++
 954
 955       .. autodoxymethod:: simgrid::s4u::Mailbox::empty()
 956       .. autodoxymethod:: simgrid::s4u::Mailbox::front()
 957       .. autodoxymethod:: simgrid::s4u::Mailbox::get()
 958       .. autodoxymethod:: simgrid::s4u::Mailbox::get(double timeout)
 959       .. autodoxymethod:: simgrid::s4u::Mailbox::get_async(void **data)
 960       .. autodoxymethod:: simgrid::s4u::Mailbox::get_init()
 961       .. autodoxymethod:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
 962       .. autodoxymethod:: simgrid::s4u::Mailbox::listen()
 963       .. autodoxymethod:: simgrid::s4u::Mailbox::ready()
 964
 965    .. group-tab:: Python
 966
 967        .. automethod:: simgrid.Mailbox.get
 968
 969    .. group-tab:: C
 970
 971       .. autodoxymethod:: sg_mailbox_listen(const char *alias)
 972
 973 Receiving actor
 974 ---------------
 975
 976 See :ref:`s4u_receiving_actor`.
 977
 978 .. tabs::
 979
 980    .. group-tab:: C++
 981
 982       .. autodoxymethod:: simgrid::s4u::Mailbox::get_receiver()
 983       .. autodoxymethod:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
 984
 985    .. group-tab:: C
 986
 987       .. autodoxymethod:: ::sg_mailbox_set_receiver(const char *alias)
 988
 989 .. _API_s4u_Resource:
 990
 991 =========
 992 Resources
 993 =========
 994
 995 .. _API_s4u_Disk:
 996
 997 =============
 998 ⁣  class Disk
 999 =============
1000
1001 .. autodoxyclass:: simgrid::s4u::Disk
1002
1003 Basic management
1004 ----------------
1005
1006 .. tabs::
1007
1008    .. group-tab:: C++
1009
1010       .. code-block:: C++
1011
1012          #include <simgrid/s4u/Disk.hpp>
1013
1014       Note that there is no DiskPtr type, and that you cannot use the RAII
1015       idiom on disks because SimGrid does not allow (yet) to create nor
1016       destroy resources once the simulation is started.
1017
1018
1019 Querying info
1020 -------------
1021
1022 .. tabs::
1023
1024    .. group-tab:: C++
1025
1026       .. autodoxymethod:: simgrid::s4u::Disk::get_cname()
1027       .. autodoxymethod:: simgrid::s4u::Disk::get_host()
1028       .. autodoxymethod:: simgrid::s4u::Disk::get_name()
1029       .. autodoxymethod:: simgrid::s4u::Disk::get_properties()
1030       .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key)
1031       .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth()
1032       .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth()
1033       .. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1034
1035 I/O operations
1036 --------------
1037
1038 .. tabs::
1039
1040    .. group-tab:: C++
1041
1042       .. autodoxymethod:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type)
1043       .. autodoxymethod:: simgrid::s4u::Disk::read(sg_size_t size)
1044       .. autodoxymethod:: simgrid::s4u::Disk::read_async(sg_size_t size)
1045       .. autodoxymethod:: simgrid::s4u::Disk::write(sg_size_t size)
1046       .. autodoxymethod:: simgrid::s4u::Disk::write_async(sg_size_t size)
1047
1048 Signals
1049 -------
1050
1051 .. tabs::
1052
1053    .. group-tab:: C++
1054
1055       .. autodoxyvar:: simgrid::s4u::Disk::on_creation
1056       .. autodoxyvar:: simgrid::s4u::Disk::on_destruction
1057       .. autodoxyvar:: simgrid::s4u::Disk::on_state_change
1058
1059
1060 .. _API_s4u_Host:
1061
1062 =============
1063 ⁣  class Host
1064 =============
1065
1066 .. autodoxyclass:: simgrid::s4u::Host
1067
1068 Basic management
1069 ----------------
1070
1071 .. tabs::
1072
1073    .. group-tab:: C++
1074
1075       .. code-block:: C++
1076
1077          #include <simgrid/s4u/Host.hpp>
1078
1079       Note that there is no HostPtr type, and that you cannot use the RAII
1080       idiom on hosts because SimGrid does not allow (yet) to create nor
1081       destroy resources once the simulation is started.
1082
1083    .. group-tab:: Python
1084
1085       .. code:: Python
1086
1087          from simgrid import Host
1088
1089    .. group-tab:: C
1090
1091       .. code:: C
1092
1093          #include <simgrid/host.h>
1094
1095       .. doxygentypedef:: sg_host_t
1096       .. cpp:type:: const s4u_Host* const_sg_host_t
1097
1098          Pointer to a constant host object.
1099
1100 Retrieving hosts
1101 ----------------
1102
1103 .. tabs::
1104
1105    .. group-tab:: C++
1106
1107       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1108
1109       .. autodoxymethod:: simgrid::s4u::Host::by_name(const std::string &name)
1110       .. autodoxymethod:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1111       .. autodoxymethod:: simgrid::s4u::Host::current()
1112
1113    .. group-tab:: Python
1114
1115       See also :py:func:`simgrid.Engine.get_all_hosts`.
1116
1117       .. automethod:: simgrid.Host.by_name
1118       .. automethod:: simgrid.Host.current
1119
1120    .. group-tab:: C
1121
1122       .. autodoxymethod:: sg_host_by_name(const char *name)
1123       .. autodoxymethod:: sg_host_count()
1124       .. autodoxymethod:: sg_host_list()
1125       .. autodoxymethod:: sg_hosts_as_dynar()
1126
1127 Querying info
1128 -------------
1129
1130 .. tabs::
1131
1132    .. group-tab:: C++
1133
1134       .. autodoxymethod:: simgrid::s4u::Host::get_cname()
1135       .. autodoxymethod:: simgrid::s4u::Host::get_core_count()
1136       .. autodoxymethod:: simgrid::s4u::Host::get_disks()
1137       .. autodoxymethod:: simgrid::s4u::Host::get_name()
1138
1139    .. group-tab:: Python
1140
1141       .. autoattribute:: simgrid.Exec.host
1142       .. autoattribute:: simgrid.Host.name
1143
1144    .. group-tab:: C
1145
1146       .. autodoxymethod:: ::sg_host_core_count(const_sg_host_t host)
1147       .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
1148
1149 DVFS
1150 ----
1151
1152 .. tabs::
1153
1154    .. group-tab:: C++
1155
1156       .. autodoxymethod:: simgrid::s4u::Host::get_pstate()
1157       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count()
1158       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index)
1159       .. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
1160       .. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1161       .. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1162
1163    .. group-tab:: Python
1164
1165       .. automethod:: simgrid.Host.get_pstate_count
1166       .. automethod:: simgrid.Host.get_pstate_speed
1167
1168    .. group-tab:: C
1169
1170       .. autodoxymethod:: sg_host_get_available_speed(const_sg_host_t host)
1171       .. autodoxymethod:: sg_host_get_nb_pstates(const_sg_host_t host)
1172       .. autodoxymethod:: sg_host_get_pstate(const_sg_host_t host)
1173       .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1174       .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
1175
1176 .. doxygenclass:: simgrid::s4u::Host
1177    :members:
1178    :protected-members:
1179    :undoc-members:
1180
1181 .. _API_s4u_Link:
1182
1183 =============
1184 ⁣  class Link
1185 =============
1186
1187 .. doxygenclass:: simgrid::s4u::Link
1188    :members:
1189    :protected-members:
1190    :undoc-members:
1191
1192 .. _API_s4u_NetZone:
1193
1194 ================
1195 ⁣  class NetZone
1196 ================
1197
1198 .. doxygenclass:: simgrid::s4u::NetZone
1199    :members:
1200    :protected-members:
1201    :undoc-members:
1202
1203 .. _API_s4u_VirtualMachine:
1204
1205 =======================
1206 ⁣  class VirtualMachine
1207 =======================
1208
1209 .. doxygenclass:: simgrid::s4u::VirtualMachine
1210    :members:
1211    :protected-members:
1212    :undoc-members:
1213
1214 .. autodoxymethod:: sg_vm_create_core
1215 .. autodoxymethod:: sg_vm_create_multicore
1216 .. autodoxymethod:: sg_vm_get_name
1217 .. autodoxymethod:: sg_vm_get_pm
1218 .. autodoxymethod:: sg_vm_is_created
1219 .. autodoxymethod:: sg_vm_is_running
1220 .. autodoxymethod:: sg_vm_is_suspended
1221 .. autodoxymethod:: sg_vm_start
1222 .. autodoxymethod:: sg_vm_suspend
1223 .. autodoxymethod:: sg_vm_resume
1224 .. autodoxymethod:: sg_vm_shutdown
1225 .. autodoxymethod:: sg_vm_destroy
1226
1227 .. _API_s4u_Activity:
1228
1229 ==============
1230 class Activity
1231 ==============
1232
1233 .. autodoxyclass:: simgrid::s4u::Activity
1234
1235    **Known subclasses:**
1236    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1237    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1238    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1239    See also the :ref:`section on activities <s4u_Activities>` above.
1240
1241 Querying info about activities
1242 ------------------------------
1243
1244    .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
1245    .. autodoxymethod:: simgrid::s4u::Activity::get_state()
1246    .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
1247    .. autodoxymethod:: simgrid::s4u::Activity::get_impl
1248
1249 Activities lifecycle
1250 --------------------
1251
1252    .. autodoxymethod:: simgrid::s4u::Activity::start
1253    .. autodoxymethod:: simgrid::s4u::Activity::cancel
1254    .. autodoxymethod:: simgrid::s4u::Activity::test
1255    .. autodoxymethod:: simgrid::s4u::Activity::wait
1256    .. autodoxymethod:: simgrid::s4u::Activity::wait_for
1257    .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
1258
1259 .. _API_s4u_Comm:
1260
1261 =============
1262 ⁣  class Comm
1263 =============
1264
1265 .. doxygentypedef:: CommPtr
1266
1267 .. doxygenclass:: simgrid::s4u::Comm
1268    :members:
1269    :protected-members:
1270    :undoc-members:
1271
1272 .. _API_s4u_Exec:
1273
1274 =============
1275 ⁣  class Exec
1276 =============
1277
1278 .. doxygentypedef:: ExecPtr
1279
1280 .. doxygenclass:: simgrid::s4u::Exec
1281    :members:
1282    :protected-members:
1283    :undoc-members:
1284
1285 .. _API_s4u_ExecSeq:
1286
1287 ==================
1288 ⁣    class ExecSeq
1289 ==================
1290
1291 .. doxygentypedef:: ExecSeqPtr
1292
1293 .. doxygenclass:: simgrid::s4u::ExecSeq
1294    :members:
1295    :protected-members:
1296    :undoc-members:
1297
1298 .. _API_s4u_ExecPar:
1299
1300 ==================
1301 ⁣    class ExecPar
1302 ==================
1303
1304 .. doxygentypedef:: ExecParPtr
1305
1306 .. doxygenclass:: simgrid::s4u::ExecPar
1307    :members:
1308    :protected-members:
1309    :undoc-members:
1310
1311 .. _API_s4u_Io:
1312
1313 ===========
1314 ⁣  class Io
1315 ===========
1316
1317 .. doxygentypedef:: IoPtr
1318
1319 .. doxygenclass:: simgrid::s4u::Io
1320    :members:
1321    :protected-members:
1322    :undoc-members:
1323
1324 .. _API_s4u_Synchronizations:
1325
1326 =======================
1327 Synchronization Objects
1328 =======================
1329
1330 .. _API_s4u_Mutex:
1331
1332 ==============
1333 ⁣  Mutex
1334 ==============
1335
1336 .. autodoxyclass:: simgrid::s4u::Mutex
1337
1338 Basic management
1339 ----------------
1340
1341    .. tabs::
1342
1343       .. group-tab:: C++
1344
1345          .. code-block:: C++
1346
1347             #include <simgrid/s4u/Mutex.hpp>
1348
1349          .. doxygentypedef:: MutexPtr
1350
1351          .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
1352          .. autodoxymethod:: simgrid::s4u::Mutex::create()
1353          .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
1354
1355       .. group-tab:: C
1356
1357          .. code-block:: C
1358
1359             #include <simgrid/mutex.h>
1360
1361          .. doxygentypedef:: sg_mutex_t
1362          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
1363
1364             Pointer to a constant mutex object.
1365
1366          .. autodoxymethod:: sg_mutex_init()
1367          .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
1368
1369 Locking
1370 -------
1371
1372    .. tabs::
1373
1374       .. group-tab:: C++
1375
1376          .. autodoxymethod:: simgrid::s4u::Mutex::lock()
1377          .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
1378          .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
1379
1380       .. group-tab:: C
1381
1382          .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
1383          .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
1384          .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
1385
1386 .. _API_s4u_Barrier:
1387
1388 ================
1389 ⁣  Barrier
1390 ================
1391
1392 .. autodoxyclass:: simgrid::s4u::Barrier
1393
1394    .. tabs::
1395
1396       .. group-tab:: C++
1397
1398          .. code-block:: C++
1399
1400             #include <simgrid/s4u/Barrier.hpp>
1401
1402          .. doxygentypedef:: BarrierPtr
1403
1404          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
1405          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
1406          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
1407
1408       .. group-tab:: C
1409
1410          .. code-block:: C
1411
1412             #include <simgrid/barrier.hpp>
1413
1414          .. doxygentypedef:: sg_bar_t
1415          .. cpp:type:: const s4u_Barrier* const_sg_bar_t
1416
1417             Pointer to a constant barrier object.
1418
1419          .. autodoxymethod:: sg_barrier_init(unsigned int count)
1420          .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
1421          .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
1422
1423
1424 .. _API_s4u_ConditionVariable:
1425
1426 ==========================
1427 ⁣  Condition variable
1428 ==========================
1429
1430 .. autodoxyclass:: simgrid::s4u::ConditionVariable
1431
1432 Basic management
1433 ----------------
1434
1435    .. tabs::
1436
1437       .. group-tab:: C++
1438
1439          .. code-block:: C++
1440
1441             #include <simgrid/s4u/ConditionVariable.hpp>
1442
1443          .. doxygentypedef:: ConditionVariablePtr
1444
1445          .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
1446
1447       .. group-tab:: C
1448
1449          .. code-block:: C
1450
1451             #include <simgrid/cond.h>
1452
1453          .. doxygentypedef:: sg_cond_t
1454          .. doxygenfunction:: sg_cond_init
1455          .. doxygenfunction:: sg_cond_destroy
1456
1457 Waiting and notifying
1458 ---------------------
1459
1460    .. tabs::
1461
1462       .. group-tab:: C++
1463
1464          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
1465          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
1466          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
1467          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
1468          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
1469          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
1470          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
1471          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
1472          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
1473          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
1474          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
1475          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
1476          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
1477
1478       .. group-tab:: C
1479
1480          .. doxygenfunction:: sg_cond_notify_all
1481          .. doxygenfunction:: sg_cond_notify_one
1482          .. doxygenfunction:: sg_cond_wait
1483          .. doxygenfunction:: sg_cond_wait_for
1484
1485 .. _API_s4u_Semaphore:
1486
1487 ==================
1488 ⁣  Semaphore
1489 ==================
1490
1491 .. autodoxyclass:: simgrid::s4u::Semaphore
1492
1493
1494 Basic management
1495 ----------------
1496
1497    .. tabs::
1498
1499       .. group-tab:: C++
1500
1501          .. code-block:: C++
1502
1503             #include <simgrid/s4u/Semaphore.hpp>
1504
1505          .. doxygentypedef:: SemaphorePtr
1506          .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
1507          .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
1508          .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
1509
1510       .. group-tab:: C
1511
1512          .. code-block:: C
1513
1514             #include <simgrid/semaphore.h>
1515
1516          .. doxygentypedef:: sg_sem_t
1517          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
1518
1519             Pointer to a constant semaphore object.
1520
1521          .. autodoxymethod:: sg_sem_init(int initial_value)
1522          .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
1523
1524 Locking
1525 -------
1526
1527    .. tabs::
1528
1529       .. group-tab:: C++
1530
1531          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
1532          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
1533          .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity()
1534          .. autodoxymethod:: simgrid::s4u::Semaphore::release()
1535          .. autodoxymethod:: simgrid::s4u::Semaphore::would_block()
1536
1537       .. group-tab:: C
1538
1539          .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
1540          .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
1541          .. autodoxymethod:: sg_sem_get_capacity(sg_sem_t sem)
1542          .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
1543          .. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)
1544
1545 Python API Reference
1546 ********************
1547
1548 The Python API is automatically generated with pybind11. It closely mimicks the C++
1549 API, to which you should refer for more information.
1550
1551 ==========
1552 Class Comm
1553 ==========
1554
1555 .. autoclass:: simgrid.Comm
1556    :members:
1557
1558 ==========
1559 Class Exec
1560 ==========
1561
1562 .. autoclass:: simgrid.Exec
1563    :members:
1564
1565 ==========
1566 Class Host
1567 ==========
1568
1569 .. autoclass:: simgrid.Host
1570    :members:
1571
1572 .. |hr| raw:: html
1573
1574    <hr />