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