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 Memory Management
 342 *****************
 343
 344 For sake of simplicity, we use `RAII
 345 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 346 for many classes in S4U. This is an idiom where resources are automatically
 347 managed through the context. Provided that you never manipulate
 348 objects of type Foo directly but always FooPtr references (which are
 349 defined as `boost::intrusive_ptr
 350 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 351 <Foo>), you will never have to explicitly release the resource that
 352 you use nor to free the memory of unused objects.
 353 Here is a little example:
 354
 355 .. code-block:: cpp
 356
 357    void myFunc()
 358    {
 359      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 360
 361      mutex->lock();   // use the mutex as a simple reference
 362      //  bla bla
 363      mutex->unlock();
 364
 365    } // The mutex gets automatically freed because the only existing reference gets out of scope
 366
 367 Note that Mailboxes, Hosts and Links are not handled thought smart
 368 pointers (yet?). This means that it is currently impossible to destroy a
 369 mailbox or a link. You can still destroy an host (but probably
 370 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 371
 372 .. THE EXAMPLES
 373
 374 .. include:: ../../examples/README.rst
 375
 376 API Reference
 377 *************
 378
 379 .. _API_s4u_simulation_object:
 380
 381 ==================
 382 Simulation objects
 383 ==================
 384
 385 .. _API_s4u_Actor:
 386
 387 ==============
 388 ⁣  class Actor
 389 ==============
 390
 391 .. autodoxyclass:: simgrid::s4u::Actor
 392
 393 .. doxygentypedef:: ActorPtr
 394
 395 .. doxygentypedef:: aid_t
 396
 397 Creating actors
 398 ---------------
 399
 400 .. tabs::
 401
 402    .. group-tab:: C++
 403
 404       .. code:: C++
 405
 406          #include <simgrid/s4u/Engine.hpp>
 407
 408       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 409       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 410       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 411       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 412
 413       .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 414       .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 415
 416    .. group-tab:: Python
 417
 418       .. code:: Python
 419
 420          from simgrid import Actor
 421
 422       .. automethod:: simgrid.Actor.create
 423
 424    .. group-tab:: C
 425
 426       .. code:: C
 427
 428          #include <simgrid/actor.h>
 429
 430       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
 431       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
 432
 433       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 434       .. autodoxymethod:: sg_actor_detach()
 435
 436       .. autodoxymethod:: sg_actor_ref(sg_actor_t actor)
 437       .. autodoxymethod:: sg_actor_unref(sg_actor_t actor)
 438
 439 Searching specific actors
 440 -------------------------
 441
 442 .. tabs::
 443
 444    .. group-tab:: C++
 445
 446       .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 447       .. autodoxymethod:: simgrid::s4u::Actor::self()
 448
 449    .. group-tab:: Python
 450
 451       .. automethod:: simgrid.Actor.by_pid
 452       .. automethod:: simgrid.Actor.self
 453
 454    .. group-tab:: C
 455
 456       .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
 457       .. autodoxymethod:: sg_actor_self()
 458
 459 Querying info about actors
 460 --------------------------
 461
 462 .. tabs::
 463
 464    .. group-tab:: C++
 465
 466       .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 467       .. autodoxymethod:: simgrid::s4u::Actor::get_name
 468       .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 469       .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 470       .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 471       .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 472       .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 473
 474       .. autodoxymethod:: simgrid::s4u::Actor::get_host
 475       .. autodoxymethod:: simgrid::s4u::Actor::set_host
 476
 477       .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
 478       .. autodoxymethod:: simgrid::s4u::Actor::get_impl
 479
 480    .. group-tab:: Python
 481
 482       .. autoattribute:: simgrid.Actor.name
 483       .. autoattribute:: simgrid.Actor.host
 484       .. autoattribute:: simgrid.Actor.pid
 485       .. autoattribute:: simgrid.Actor.ppid
 486
 487    .. group-tab:: C
 488
 489       .. autodoxymethod:: sg_actor_get_name(sg_actor_t actor)
 490       .. autodoxymethod:: sg_actor_get_PID(sg_actor_t actor)
 491       .. autodoxymethod:: sg_actor_get_PPID(sg_actor_t actor)
 492       .. autodoxymethod:: sg_actor_get_properties(sg_actor_t actor)
 493       .. autodoxymethod:: sg_actor_get_property_value(sg_actor_t actor, const char *name)
 494
 495       .. autodoxymethod:: sg_actor_get_host(sg_actor_t actor)
 496       .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 497
 498       .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor)
 499       .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata)
 500
 501 Suspending and resuming actors
 502 ------------------------------
 503
 504 .. tabs::
 505
 506    .. group-tab:: C++
 507
 508       .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 509       .. autodoxymethod:: simgrid::s4u::Actor::resume()
 510       .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
 511
 512    .. group-tab:: Python
 513
 514       .. automethod:: simgrid.Actor.resume
 515       .. automethod:: simgrid.Actor.suspend
 516       .. automethod:: simgrid.Actor.is_suspended
 517
 518    .. group-tab:: C
 519
 520       .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
 521       .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
 522       .. autodoxymethod:: sg_actor_is_suspended(sg_actor_t actor)
 523
 524 Specifying when actors should terminate
 525 ---------------------------------------
 526
 527 .. tabs::
 528
 529    .. group-tab:: C++
 530
 531       .. autodoxymethod:: simgrid::s4u::Actor::kill()
 532       .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 533       .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 534       .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
 535
 536       .. autodoxymethod:: simgrid::s4u::Actor::restart()
 537       .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 538       .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 539
 540    .. group-tab:: Python
 541
 542       .. automethod:: simgrid.Actor.kill
 543       .. automethod:: simgrid.Actor.kill_all
 544
 545       .. automethod:: simgrid.Actor.daemonize
 546       .. automethod:: simgrid.Actor.is_daemon
 547
 548    .. group-tab:: C
 549
 550       .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
 551       .. autodoxymethod:: sg_actor_kill_all()
 552       .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 553
 554       .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
 555       .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
 556
 557 .. _API_s4u_Actor_end:
 558
 559 Reacting to the end of actors
 560 -----------------------------
 561
 562 .. tabs::
 563
 564    .. group-tab:: C++
 565
 566       .. autodoxymethod:: simgrid::s4u::Actor::on_exit
 567       .. autodoxymethod:: simgrid::s4u::Actor::join()
 568       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
 569       .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 570
 571    .. group-tab:: Python
 572
 573       .. automethod:: simgrid.Actor.join
 574
 575    .. group-tab:: C
 576
 577       .. autodoxymethod:: sg_actor_join(sg_actor_t actor, double timeout)
 578       .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 579
 580 Signals
 581 -------
 582
 583 .. tabs::
 584
 585    .. group-tab:: C++
 586
 587       .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 588       .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 589       .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 590       .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 591       .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 592       .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 593       .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 594
 595 .. _API_s4u_this_actor:
 596
 597 ====================
 598 ⁣  The current actor
 599 ====================
 600
 601 Static methods working on the current actor (see :ref:`API_s4u_Actor`).
 602
 603 .. doxygennamespace:: simgrid::s4u::this_actor
 604
 605 .. _API_s4u_Engine:
 606
 607 ====================
 608 ⁣  Simulation Engine
 609 ====================
 610
 611 .. autodoxyclass:: simgrid::s4u::Engine
 612
 613 Initialization
 614 --------------
 615
 616 .. tabs::
 617
 618    .. group-tab:: C++
 619
 620       .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 621       .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
 622       .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
 623       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
 624
 625       .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
 626       .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
 627       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
 628       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 629       .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
 630       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
 631       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
 632
 633    .. group-tab:: Python
 634
 635        .. automethod:: simgrid.Engine.load_deployment
 636        .. automethod:: simgrid.Engine.load_platform
 637        .. automethod:: simgrid.Engine.register_actor
 638
 639    .. group-tab:: C
 640
 641       .. autodoxymethod:: simgrid_init
 642
 643       .. autodoxymethod:: simgrid_load_deployment
 644       .. autodoxymethod:: simgrid_load_platform
 645       .. autodoxymethod:: simgrid_register_default
 646       .. autodoxymethod:: simgrid_register_function
 647
 648 Run the simulation
 649 ------------------
 650
 651 .. tabs::
 652
 653    .. group-tab:: C++
 654
 655       .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
 656       .. autodoxymethod:: simgrid::s4u::Engine::run()
 657
 658    .. group-tab:: Python
 659
 660       .. automethod:: simgrid.Engine.get_clock
 661       .. automethod:: simgrid.Engine.run
 662
 663    .. group-tab:: C
 664
 665       .. autodoxymethod:: simgrid_get_clock
 666       .. autodoxymethod:: simgrid_run
 667
 668 Retrieving actors
 669 -----------------
 670
 671 .. tabs::
 672
 673    .. group-tab:: C++
 674
 675       .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
 676       .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
 677       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
 678
 679    .. group-tab:: C
 680
 681       .. autodoxymethod:: simgrid_get_actor_count()
 682
 683 Retrieving hosts
 684 ----------------
 685
 686 .. tabs::
 687
 688    .. group-tab:: C++
 689
 690       .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
 691       .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
 692       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
 693       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
 694       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
 695
 696    .. group-tab:: Python
 697
 698       .. automethod:: simgrid.Engine.get_all_hosts
 699
 700 Retrieving links
 701 ----------------
 702
 703 .. tabs::
 704
 705    .. group-tab:: C++
 706
 707       .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
 708       .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
 709       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
 710       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
 711       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
 712
 713 Interacting with the routing
 714 ----------------------------
 715
 716 .. tabs::
 717
 718    .. group-tab:: C++
 719
 720       .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
 721       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
 722       .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
 723       .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
 724       .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
 725       .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
 726       .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(NetZone *netzone)
 727
 728 Signals
 729 -------
 730
 731 .. tabs::
 732
 733    .. group-tab:: C++
 734
 735       .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
 736       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
 737       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
 738       .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
 739       .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
 740
 741 .. _API_s4u_Mailbox:
 742
 743 ================
 744 ⁣  class Mailbox
 745 ================
 746
 747 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 748
 749 .. doxygenclass:: simgrid::s4u::Mailbox
 750    :members:
 751    :protected-members:
 752    :undoc-members:
 753 .. _API_s4u_Resource:
 754
 755 =========
 756 Resources
 757 =========
 758
 759 .. _API_s4u_Disk:
 760
 761 =============
 762 ⁣  class Disk
 763 =============
 764
 765 .. doxygenclass:: simgrid::s4u::Disk
 766    :members:
 767    :protected-members:
 768    :undoc-members:
 769
 770
 771
 772 .. _API_s4u_Host:
 773
 774 =============
 775 ⁣  class Host
 776 =============
 777
 778 .. doxygenclass:: simgrid::s4u::Host
 779    :members:
 780    :protected-members:
 781    :undoc-members:
 782
 783 .. _API_s4u_Link:
 784
 785 =============
 786 ⁣  class Link
 787 =============
 788
 789 .. doxygenclass:: simgrid::s4u::Link
 790    :members:
 791    :protected-members:
 792    :undoc-members:
 793
 794 .. _API_s4u_NetZone:
 795
 796 ================
 797 ⁣  class NetZone
 798 ================
 799
 800 .. doxygenclass:: simgrid::s4u::NetZone
 801    :members:
 802    :protected-members:
 803    :undoc-members:
 804
 805 .. _API_s4u_VirtualMachine:
 806
 807 =======================
 808 ⁣  class VirtualMachine
 809 =======================
 810
 811 .. doxygenclass:: simgrid::s4u::VirtualMachine
 812    :members:
 813    :protected-members:
 814    :undoc-members:
 815
 816 .. autodoxymethod:: sg_vm_create_core
 817 .. autodoxymethod:: sg_vm_create_multicore
 818 .. autodoxymethod:: sg_vm_get_name
 819 .. autodoxymethod:: sg_vm_get_pm
 820 .. autodoxymethod:: sg_vm_is_created
 821 .. autodoxymethod:: sg_vm_is_running
 822 .. autodoxymethod:: sg_vm_is_suspended
 823 .. autodoxymethod:: sg_vm_start
 824 .. autodoxymethod:: sg_vm_suspend
 825 .. autodoxymethod:: sg_vm_resume
 826 .. autodoxymethod:: sg_vm_shutdown
 827 .. autodoxymethod:: sg_vm_destroy
 828
 829 .. _API_s4u_Activity:
 830
 831 ==============
 832 class Activity
 833 ==============
 834
 835 .. autodoxyclass:: simgrid::s4u::Activity
 836
 837    **Known subclasses:**
 838    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
 839    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
 840    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
 841    See also the :ref:`section on activities <s4u_Activities>` above.
 842
 843 Querying info about activities
 844 ------------------------------
 845
 846    .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
 847    .. autodoxymethod:: simgrid::s4u::Activity::get_state()
 848    .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
 849    .. autodoxymethod:: simgrid::s4u::Activity::get_impl
 850
 851 Activities lifecycle
 852 --------------------
 853
 854    .. autodoxymethod:: simgrid::s4u::Activity::start
 855    .. autodoxymethod:: simgrid::s4u::Activity::cancel
 856    .. autodoxymethod:: simgrid::s4u::Activity::test
 857    .. autodoxymethod:: simgrid::s4u::Activity::wait
 858    .. autodoxymethod:: simgrid::s4u::Activity::wait_for
 859    .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
 860
 861 .. _API_s4u_Comm:
 862
 863 =============
 864 ⁣  class Comm
 865 =============
 866
 867 .. doxygentypedef:: CommPtr
 868
 869 .. doxygenclass:: simgrid::s4u::Comm
 870    :members:
 871    :protected-members:
 872    :undoc-members:
 873
 874 .. _API_s4u_Exec:
 875
 876 =============
 877 ⁣  class Exec
 878 =============
 879
 880 .. doxygentypedef:: ExecPtr
 881
 882 .. doxygenclass:: simgrid::s4u::Exec
 883    :members:
 884    :protected-members:
 885    :undoc-members:
 886
 887 .. _API_s4u_ExecSeq:
 888
 889 ==================
 890 ⁣    class ExecSeq
 891 ==================
 892
 893 .. doxygentypedef:: ExecSeqPtr
 894
 895 .. doxygenclass:: simgrid::s4u::ExecSeq
 896    :members:
 897    :protected-members:
 898    :undoc-members:
 899
 900 .. _API_s4u_ExecPar:
 901
 902 ==================
 903 ⁣    class ExecPar
 904 ==================
 905
 906 .. doxygentypedef:: ExecParPtr
 907
 908 .. doxygenclass:: simgrid::s4u::ExecPar
 909    :members:
 910    :protected-members:
 911    :undoc-members:
 912
 913 .. _API_s4u_Io:
 914
 915 ===========
 916 ⁣  class Io
 917 ===========
 918
 919 .. doxygentypedef:: IoPtr
 920
 921 .. doxygenclass:: simgrid::s4u::Io
 922    :members:
 923    :protected-members:
 924    :undoc-members:
 925
 926 .. _API_s4u_Synchronizations:
 927
 928 =======================
 929 Synchronization Objects
 930 =======================
 931
 932 .. _API_s4u_Barrier:
 933
 934 ================
 935 ⁣  class Barrier
 936 ================
 937
 938 .. doxygentypedef:: BarrierPtr
 939
 940 .. autodoxyclass:: simgrid::s4u::Barrier
 941
 942    .. tabs::
 943
 944       .. group-tab:: C++
 945
 946          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
 947          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
 948          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
 949
 950
 951 .. _API_s4u_ConditionVariable:
 952
 953 ==========================
 954 ⁣  class ConditionVariable
 955 ==========================
 956
 957 .. doxygentypedef:: ConditionVariablePtr
 958
 959 .. doxygenclass:: simgrid::s4u::ConditionVariable
 960    :members:
 961    :protected-members:
 962    :undoc-members:
 963
 964 .. _API_s4u_Mutex:
 965
 966 ==============
 967 ⁣  class Mutex
 968 ==============
 969
 970 .. doxygentypedef:: MutexPtr
 971
 972 .. doxygenclass:: simgrid::s4u::Mutex
 973    :members:
 974    :protected-members:
 975    :undoc-members:
 976
 977 .. _API_s4u_Semaphore:
 978
 979 ==================
 980 ⁣  class Semaphore
 981 ==================
 982
 983 .. doxygentypedef:: SemaphorePtr
 984
 985 .. doxygenclass:: simgrid::s4u::Semaphore
 986    :members:
 987    :protected-members:
 988    :undoc-members:
 989
 990
 991 C API Reference
 992 ***************
 993
 994 ==================
 995 Condition Variable
 996 ==================
 997
 998 See also the :ref:`C++ API <API_s4u_ConditionVariable>`.
 999
1000 .. doxygenfunction:: sg_cond_init
1001 .. doxygenfunction:: sg_cond_notify_all
1002 .. doxygenfunction:: sg_cond_notify_one
1003 .. doxygenfunction:: sg_cond_wait
1004 .. doxygenfunction:: sg_cond_wait_for
1005
1006 Python API Reference
1007 ********************
1008
1009 The Python API is automatically generated with pybind11. It closely mimicks the C++
1010 API, to which you should refer for more information.
1011
1012 ==========
1013 this_actor
1014 ==========
1015
1016 .. automodule:: simgrid.this_actor
1017    :members:
1018
1019 ===========
1020 Class Actor
1021 ===========
1022
1023 .. autoclass:: simgrid.Actor
1024    :members:
1025
1026 ==========
1027 Class Comm
1028 ==========
1029
1030 .. autoclass:: simgrid.Comm
1031    :members:
1032
1033 ============
1034 Class Engine
1035 ============
1036
1037 .. autoclass:: simgrid.Engine
1038    :members:
1039
1040 ==========
1041 Class Exec
1042 ==========
1043
1044 .. autoclass:: simgrid.Exec
1045    :members:
1046
1047 ==========
1048 Class Host
1049 ==========
1050
1051 .. autoclass:: simgrid.Host
1052    :members:
1053
1054 =============
1055 Class Mailbox
1056 =============
1057
1058 .. autoclass:: simgrid.Mailbox
1059    :members:
1060
1061 .. |hr| raw:: html
1062
1063    <hr />