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:: ActorPtr
 396
 397 .. doxygentypedef:: aid_t
 398
 399 Creating actors
 400 ---------------
 401
 402 .. tabs::
 403
 404    .. group-tab:: C++
 405
 406       .. code:: C++
 407
 408          #include <simgrid/s4u/Engine.hpp>
 409
 410       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 411       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 412       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 413       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 414
 415       .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 416       .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 417
 418    .. group-tab:: Python
 419
 420       .. code:: Python
 421
 422          from simgrid import Actor
 423
 424       .. automethod:: simgrid.Actor.create
 425
 426    .. group-tab:: C
 427
 428       .. code:: C
 429
 430          #include <simgrid/actor.h>
 431
 432       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
 433       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
 434
 435       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 436       .. autodoxymethod:: sg_actor_detach()
 437
 438       .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
 439       .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
 440
 441 Searching specific actors
 442 -------------------------
 443
 444 .. tabs::
 445
 446    .. group-tab:: C++
 447
 448       .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 449       .. autodoxymethod:: simgrid::s4u::Actor::self()
 450
 451    .. group-tab:: Python
 452
 453       .. automethod:: simgrid.Actor.by_pid
 454       .. automethod:: simgrid.Actor.self
 455
 456    .. group-tab:: C
 457
 458       .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
 459       .. autodoxymethod:: sg_actor_self()
 460
 461 Querying info about actors
 462 --------------------------
 463
 464 .. tabs::
 465
 466    .. group-tab:: C++
 467
 468       .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 469       .. autodoxymethod:: simgrid::s4u::Actor::get_name
 470       .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 471       .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 472       .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 473       .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 474       .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 475
 476       .. autodoxymethod:: simgrid::s4u::Actor::get_host
 477       .. autodoxymethod:: simgrid::s4u::Actor::set_host
 478
 479       .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
 480       .. autodoxymethod:: simgrid::s4u::Actor::get_impl
 481
 482    .. group-tab:: Python
 483
 484       .. autoattribute:: simgrid.Actor.name
 485       .. autoattribute:: simgrid.Actor.host
 486       .. autoattribute:: simgrid.Actor.pid
 487       .. autoattribute:: simgrid.Actor.ppid
 488
 489    .. group-tab:: C
 490
 491       .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
 492       .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
 493       .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
 494       .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
 495       .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 496
 497       .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
 498       .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 499
 500       .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor)
 501       .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata)
 502
 503 Suspending and resuming actors
 504 ------------------------------
 505
 506 .. tabs::
 507
 508    .. group-tab:: C++
 509
 510       .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 511       .. autodoxymethod:: simgrid::s4u::Actor::resume()
 512       .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
 513
 514    .. group-tab:: Python
 515
 516       .. automethod:: simgrid.Actor.resume
 517       .. automethod:: simgrid.Actor.suspend
 518       .. automethod:: simgrid.Actor.is_suspended
 519
 520    .. group-tab:: C
 521
 522       .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
 523       .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
 524       .. autodoxymethod:: sg_actor_is_suspended(sg_actor_t actor)
 525
 526 Specifying when actors should terminate
 527 ---------------------------------------
 528
 529 .. tabs::
 530
 531    .. group-tab:: C++
 532
 533       .. autodoxymethod:: simgrid::s4u::Actor::kill()
 534       .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 535       .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 536       .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
 537
 538       .. autodoxymethod:: simgrid::s4u::Actor::restart()
 539       .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 540       .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 541
 542    .. group-tab:: Python
 543
 544       .. automethod:: simgrid.Actor.kill
 545       .. automethod:: simgrid.Actor.kill_all
 546
 547       .. automethod:: simgrid.Actor.daemonize
 548       .. automethod:: simgrid.Actor.is_daemon
 549
 550    .. group-tab:: C
 551
 552       .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
 553       .. autodoxymethod:: sg_actor_kill_all()
 554       .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 555
 556       .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
 557       .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
 558
 559 .. _API_s4u_Actor_end:
 560
 561 Reacting to the end of actors
 562 -----------------------------
 563
 564 .. tabs::
 565
 566    .. group-tab:: C++
 567
 568       .. autodoxymethod:: simgrid::s4u::Actor::on_exit
 569       .. autodoxymethod:: simgrid::s4u::Actor::join()
 570       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
 571       .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 572
 573    .. group-tab:: Python
 574
 575       .. automethod:: simgrid.Actor.join
 576
 577    .. group-tab:: C
 578
 579       .. autodoxymethod:: sg_actor_join(sg_actor_t actor, double timeout)
 580       .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 581
 582 Signals
 583 -------
 584
 585 .. tabs::
 586
 587    .. group-tab:: C++
 588
 589       .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 590       .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 591       .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 592       .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 593       .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 594       .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 595       .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 596
 597 .. _API_s4u_this_actor:
 598
 599 ====================
 600 ⁣  The current actor
 601 ====================
 602
 603 Static methods working on the current actor (see :ref:`API_s4u_Actor`).
 604
 605 .. doxygennamespace:: simgrid::s4u::this_actor
 606
 607 .. _API_s4u_Engine:
 608
 609 ====================
 610 ⁣  Simulation Engine
 611 ====================
 612
 613 .. autodoxyclass:: simgrid::s4u::Engine
 614
 615 Initialization
 616 --------------
 617
 618 .. tabs::
 619
 620    .. group-tab:: C++
 621
 622       .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 623       .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
 624       .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
 625       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
 626
 627       .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
 628       .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
 629       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
 630       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 631       .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
 632       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
 633       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
 634
 635    .. group-tab:: Python
 636
 637        .. automethod:: simgrid.Engine.load_deployment
 638        .. automethod:: simgrid.Engine.load_platform
 639        .. automethod:: simgrid.Engine.register_actor
 640
 641    .. group-tab:: C
 642
 643       .. autodoxymethod:: simgrid_init
 644
 645       .. autodoxymethod:: simgrid_load_deployment
 646       .. autodoxymethod:: simgrid_load_platform
 647       .. autodoxymethod:: simgrid_register_default
 648       .. autodoxymethod:: simgrid_register_function
 649
 650 Run the simulation
 651 ------------------
 652
 653 .. tabs::
 654
 655    .. group-tab:: C++
 656
 657       .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
 658       .. autodoxymethod:: simgrid::s4u::Engine::run()
 659
 660    .. group-tab:: Python
 661
 662       .. automethod:: simgrid.Engine.get_clock
 663       .. automethod:: simgrid.Engine.run
 664
 665    .. group-tab:: C
 666
 667       .. autodoxymethod:: simgrid_get_clock
 668       .. autodoxymethod:: simgrid_run
 669
 670 Retrieving actors
 671 -----------------
 672
 673 .. tabs::
 674
 675    .. group-tab:: C++
 676
 677       .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
 678       .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
 679       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
 680
 681    .. group-tab:: C
 682
 683       .. autodoxymethod:: simgrid_get_actor_count()
 684
 685 Retrieving hosts
 686 ----------------
 687
 688 .. tabs::
 689
 690    .. group-tab:: C++
 691
 692       .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
 693       .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
 694       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
 695       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
 696       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
 697
 698    .. group-tab:: Python
 699
 700       .. automethod:: simgrid.Engine.get_all_hosts
 701
 702 Retrieving links
 703 ----------------
 704
 705 .. tabs::
 706
 707    .. group-tab:: C++
 708
 709       .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
 710       .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
 711       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
 712       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
 713       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
 714
 715 Interacting with the routing
 716 ----------------------------
 717
 718 .. tabs::
 719
 720    .. group-tab:: C++
 721
 722       .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
 723       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
 724       .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
 725       .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
 726       .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
 727       .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
 728       .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 729
 730 Signals
 731 -------
 732
 733 .. tabs::
 734
 735    .. group-tab:: C++
 736
 737       .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
 738       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
 739       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
 740       .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
 741       .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
 742
 743 .. _API_s4u_Mailbox:
 744
 745 ================
 746 ⁣  class Mailbox
 747 ================
 748
 749 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 750
 751 .. doxygenclass:: simgrid::s4u::Mailbox
 752    :members:
 753    :protected-members:
 754    :undoc-members:
 755 .. _API_s4u_Resource:
 756
 757 =========
 758 Resources
 759 =========
 760
 761 .. _API_s4u_Disk:
 762
 763 =============
 764 ⁣  class Disk
 765 =============
 766
 767 .. doxygenclass:: simgrid::s4u::Disk
 768    :members:
 769    :protected-members:
 770    :undoc-members:
 771
 772
 773
 774 .. _API_s4u_Host:
 775
 776 =============
 777 ⁣  class Host
 778 =============
 779
 780 .. doxygenclass:: simgrid::s4u::Host
 781    :members:
 782    :protected-members:
 783    :undoc-members:
 784
 785 .. _API_s4u_Link:
 786
 787 =============
 788 ⁣  class Link
 789 =============
 790
 791 .. doxygenclass:: simgrid::s4u::Link
 792    :members:
 793    :protected-members:
 794    :undoc-members:
 795
 796 .. _API_s4u_NetZone:
 797
 798 ================
 799 ⁣  class NetZone
 800 ================
 801
 802 .. doxygenclass:: simgrid::s4u::NetZone
 803    :members:
 804    :protected-members:
 805    :undoc-members:
 806
 807 .. _API_s4u_VirtualMachine:
 808
 809 =======================
 810 ⁣  class VirtualMachine
 811 =======================
 812
 813 .. doxygenclass:: simgrid::s4u::VirtualMachine
 814    :members:
 815    :protected-members:
 816    :undoc-members:
 817
 818 .. autodoxymethod:: sg_vm_create_core
 819 .. autodoxymethod:: sg_vm_create_multicore
 820 .. autodoxymethod:: sg_vm_get_name
 821 .. autodoxymethod:: sg_vm_get_pm
 822 .. autodoxymethod:: sg_vm_is_created
 823 .. autodoxymethod:: sg_vm_is_running
 824 .. autodoxymethod:: sg_vm_is_suspended
 825 .. autodoxymethod:: sg_vm_start
 826 .. autodoxymethod:: sg_vm_suspend
 827 .. autodoxymethod:: sg_vm_resume
 828 .. autodoxymethod:: sg_vm_shutdown
 829 .. autodoxymethod:: sg_vm_destroy
 830
 831 .. _API_s4u_Activity:
 832
 833 ==============
 834 class Activity
 835 ==============
 836
 837 .. autodoxyclass:: simgrid::s4u::Activity
 838
 839    **Known subclasses:**
 840    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
 841    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
 842    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
 843    See also the :ref:`section on activities <s4u_Activities>` above.
 844
 845 Querying info about activities
 846 ------------------------------
 847
 848    .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
 849    .. autodoxymethod:: simgrid::s4u::Activity::get_state()
 850    .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
 851    .. autodoxymethod:: simgrid::s4u::Activity::get_impl
 852
 853 Activities lifecycle
 854 --------------------
 855
 856    .. autodoxymethod:: simgrid::s4u::Activity::start
 857    .. autodoxymethod:: simgrid::s4u::Activity::cancel
 858    .. autodoxymethod:: simgrid::s4u::Activity::test
 859    .. autodoxymethod:: simgrid::s4u::Activity::wait
 860    .. autodoxymethod:: simgrid::s4u::Activity::wait_for
 861    .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
 862
 863 .. _API_s4u_Comm:
 864
 865 =============
 866 ⁣  class Comm
 867 =============
 868
 869 .. doxygentypedef:: CommPtr
 870
 871 .. doxygenclass:: simgrid::s4u::Comm
 872    :members:
 873    :protected-members:
 874    :undoc-members:
 875
 876 .. _API_s4u_Exec:
 877
 878 =============
 879 ⁣  class Exec
 880 =============
 881
 882 .. doxygentypedef:: ExecPtr
 883
 884 .. doxygenclass:: simgrid::s4u::Exec
 885    :members:
 886    :protected-members:
 887    :undoc-members:
 888
 889 .. _API_s4u_ExecSeq:
 890
 891 ==================
 892 ⁣    class ExecSeq
 893 ==================
 894
 895 .. doxygentypedef:: ExecSeqPtr
 896
 897 .. doxygenclass:: simgrid::s4u::ExecSeq
 898    :members:
 899    :protected-members:
 900    :undoc-members:
 901
 902 .. _API_s4u_ExecPar:
 903
 904 ==================
 905 ⁣    class ExecPar
 906 ==================
 907
 908 .. doxygentypedef:: ExecParPtr
 909
 910 .. doxygenclass:: simgrid::s4u::ExecPar
 911    :members:
 912    :protected-members:
 913    :undoc-members:
 914
 915 .. _API_s4u_Io:
 916
 917 ===========
 918 ⁣  class Io
 919 ===========
 920
 921 .. doxygentypedef:: IoPtr
 922
 923 .. doxygenclass:: simgrid::s4u::Io
 924    :members:
 925    :protected-members:
 926    :undoc-members:
 927
 928 .. _API_s4u_Synchronizations:
 929
 930 =======================
 931 Synchronization Objects
 932 =======================
 933
 934 .. _API_s4u_Mutex:
 935
 936 ==============
 937 ⁣  Mutex
 938 ==============
 939
 940 .. autodoxyclass:: simgrid::s4u::Mutex
 941
 942 Basic management
 943 ----------------
 944
 945    .. tabs::
 946
 947       .. group-tab:: C++
 948
 949          .. code-block:: C++
 950
 951             #include <simgrid/s4u/Mutex.hpp>
 952
 953          .. doxygentypedef:: MutexPtr
 954
 955          .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
 956          .. autodoxymethod:: simgrid::s4u::Mutex::create()
 957          .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
 958
 959       .. group-tab:: C
 960
 961          .. code-block:: C
 962
 963             #include <simgrid/mutex.h>
 964
 965          .. doxygentypedef:: sg_mutex_t
 966          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
 967
 968             Pointer to a constant mutex object.
 969
 970          .. autodoxymethod:: sg_mutex_init()
 971          .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
 972
 973 Locking
 974 -------
 975
 976    .. tabs::
 977
 978       .. group-tab:: C++
 979
 980          .. autodoxymethod:: simgrid::s4u::Mutex::lock()
 981          .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
 982          .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
 983
 984       .. group-tab:: C
 985
 986          .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
 987          .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
 988          .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
 989
 990 .. _API_s4u_Barrier:
 991
 992 ================
 993 ⁣  Barrier
 994 ================
 995
 996 .. autodoxyclass:: simgrid::s4u::Barrier
 997
 998    .. tabs::
 999
1000       .. group-tab:: C++
1001
1002          .. code-block:: C++
1003
1004             #include <simgrid/s4u/Barrier.hpp>
1005
1006          .. doxygentypedef:: BarrierPtr
1007
1008          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
1009          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
1010          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
1011
1012       .. group-tab:: C
1013
1014          .. code-block:: C
1015
1016             #include <simgrid/barrier.hpp>
1017
1018          .. doxygentypedef:: sg_bar_t
1019          .. cpp:type:: const s4u_Barrier* const_sg_bar_t
1020
1021             Pointer to a constant barrier object.
1022
1023          .. autodoxymethod:: sg_barrier_init(unsigned int count)
1024          .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
1025          .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
1026
1027
1028 .. _API_s4u_ConditionVariable:
1029
1030 ==========================
1031 ⁣  Condition variable
1032 ==========================
1033
1034 .. autodoxyclass:: simgrid::s4u::ConditionVariable
1035
1036 Basic management
1037 ----------------
1038
1039    .. tabs::
1040
1041       .. group-tab:: C++
1042
1043          .. code-block:: C++
1044
1045             #include <simgrid/s4u/ConditionVariable.hpp>
1046
1047          .. doxygentypedef:: ConditionVariablePtr
1048
1049          .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
1050
1051       .. group-tab:: C
1052
1053          .. code-block:: C
1054
1055             #include <simgrid/cond.h>
1056
1057          .. doxygentypedef:: sg_cond_t
1058          .. doxygenfunction:: sg_cond_init
1059          .. doxygenfunction:: sg_cond_destroy
1060
1061 Waiting and notifying
1062 ---------------------
1063
1064    .. tabs::
1065
1066       .. group-tab:: C++
1067
1068          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
1069          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
1070          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
1071          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
1072          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
1073          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
1074          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
1075          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
1076          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
1077          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
1078          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
1079          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
1080          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
1081
1082       .. group-tab:: C
1083
1084          .. doxygenfunction:: sg_cond_notify_all
1085          .. doxygenfunction:: sg_cond_notify_one
1086          .. doxygenfunction:: sg_cond_wait
1087          .. doxygenfunction:: sg_cond_wait_for
1088
1089 .. _API_s4u_Semaphore:
1090
1091 ==================
1092 ⁣  Semaphore
1093 ==================
1094
1095 .. autodoxyclass:: simgrid::s4u::Semaphore
1096
1097
1098 Basic management
1099 ----------------
1100
1101    .. tabs::
1102
1103       .. group-tab:: C++
1104
1105          .. code-block:: C++
1106
1107             #include <simgrid/s4u/Semaphore.hpp>
1108
1109          .. doxygentypedef:: SemaphorePtr
1110          .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
1111          .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
1112          .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
1113
1114       .. group-tab:: C
1115
1116          .. code-block:: C
1117
1118             #include <simgrid/semaphore.h>
1119
1120          .. doxygentypedef:: sg_sem_t
1121          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
1122
1123             Pointer to a constant semaphore object.
1124
1125          .. autodoxymethod:: sg_sem_init(int initial_value)
1126          .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
1127
1128 Locking
1129 -------
1130
1131    .. tabs::
1132
1133       .. group-tab:: C++
1134
1135          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
1136          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
1137          .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity()
1138          .. autodoxymethod:: simgrid::s4u::Semaphore::release()
1139          .. autodoxymethod:: simgrid::s4u::Semaphore::would_block()
1140
1141       .. group-tab:: C
1142
1143          .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
1144          .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
1145          .. autodoxymethod:: sg_sem_get_capacity(sg_sem_t sem)
1146          .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
1147          .. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)
1148
1149 Python API Reference
1150 ********************
1151
1152 The Python API is automatically generated with pybind11. It closely mimicks the C++
1153 API, to which you should refer for more information.
1154
1155 ==========
1156 this_actor
1157 ==========
1158
1159 .. automodule:: simgrid.this_actor
1160    :members:
1161
1162 ==========
1163 Class Comm
1164 ==========
1165
1166 .. autoclass:: simgrid.Comm
1167    :members:
1168
1169 ==========
1170 Class Exec
1171 ==========
1172
1173 .. autoclass:: simgrid.Exec
1174    :members:
1175
1176 ==========
1177 Class Host
1178 ==========
1179
1180 .. autoclass:: simgrid.Host
1181    :members:
1182
1183 =============
1184 Class Mailbox
1185 =============
1186
1187 .. autoclass:: simgrid.Mailbox
1188    :members:
1189
1190 .. |hr| raw:: html
1191
1192    <hr />