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 .. doxygentypedef:: ActorPtr
 392
 393 .. doxygentypedef:: aid_t
 394
 395 .. autodoxyclass:: simgrid::s4u::Actor
 396
 397 Creating actors
 398 ---------------
 399
 400 .. tabs::
 401
 402    .. group-tab:: C++
 403
 404       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 405       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 406       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 407       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 408
 409       .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 410       .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 411
 412    .. group-tab:: Python
 413
 414       .. automethod:: simgrid.Actor.create
 415
 416 Searching specific actors
 417 -------------------------
 418
 419 .. tabs::
 420
 421    .. group-tab:: C++
 422
 423       .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 424       .. autodoxymethod:: simgrid::s4u::Actor::self()
 425
 426    .. group-tab:: Python
 427
 428       .. automethod:: simgrid.Actor.by_pid
 429       .. automethod:: simgrid.Actor.self
 430
 431 Querying info about actors
 432 --------------------------
 433
 434 .. tabs::
 435
 436    .. group-tab:: C++
 437
 438       .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 439       .. autodoxymethod:: simgrid::s4u::Actor::get_name
 440       .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 441       .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 442       .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 443       .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 444       .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 445
 446       .. autodoxymethod:: simgrid::s4u::Actor::get_host
 447       .. autodoxymethod:: simgrid::s4u::Actor::set_host
 448
 449       .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
 450       .. autodoxymethod:: simgrid::s4u::Actor::get_impl
 451
 452    .. group-tab:: Python
 453
 454       .. autoattribute:: simgrid.Actor.name
 455       .. autoattribute:: simgrid.Actor.host
 456       .. autoattribute:: simgrid.Actor.pid
 457       .. autoattribute:: simgrid.Actor.ppid
 458
 459 Suspending and resuming actors
 460 ------------------------------
 461
 462 .. tabs::
 463
 464    .. group-tab:: C++
 465
 466       .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 467       .. autodoxymethod:: simgrid::s4u::Actor::resume()
 468       .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
 469
 470    .. group-tab:: Python
 471
 472       .. automethod:: simgrid.Actor.resume
 473       .. automethod:: simgrid.Actor.suspend
 474       .. automethod:: simgrid.Actor.is_suspended
 475
 476 Specifying when actors should terminate
 477 ---------------------------------------
 478
 479 .. tabs::
 480
 481    .. group-tab:: C++
 482
 483       .. autodoxymethod:: simgrid::s4u::Actor::kill()
 484       .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 485       .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 486       .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
 487
 488       .. autodoxymethod:: simgrid::s4u::Actor::restart()
 489       .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 490       .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 491
 492    .. group-tab:: Python
 493
 494       .. automethod:: simgrid.Actor.kill
 495       .. automethod:: simgrid.Actor.kill_all
 496
 497       .. automethod:: simgrid.Actor.daemonize
 498       .. automethod:: simgrid.Actor.is_daemon
 499
 500 Reacting to the end of actors
 501 -----------------------------
 502
 503 .. tabs::
 504
 505    .. group-tab:: C++
 506
 507       .. autodoxymethod:: simgrid::s4u::Actor::on_exit
 508       .. autodoxymethod:: simgrid::s4u::Actor::join()
 509       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
 510       .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 511
 512    .. group-tab:: Python
 513
 514       .. automethod:: simgrid.Actor.join
 515
 516 Signals
 517 -------
 518
 519 .. tabs::
 520
 521    .. group-tab:: C++
 522
 523       .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 524       .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 525       .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 526       .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 527       .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 528       .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 529       .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 530
 531 .. _API_s4u_this_actor:
 532
 533 ====================
 534 ⁣  The current actor
 535 ====================
 536
 537 Static methods working on the current actor (see :ref:`API_s4u_Actor`).
 538
 539 .. doxygennamespace:: simgrid::s4u::this_actor
 540
 541 .. _API_s4u_Engine:
 542
 543 ====================
 544 ⁣  Simulation Engine
 545 ====================
 546
 547 .. doxygenclass:: simgrid::s4u::Engine
 548    :members:
 549    :protected-members:
 550    :undoc-members:
 551
 552 .. _API_s4u_Mailbox:
 553
 554 ================
 555 ⁣  class Mailbox
 556 ================
 557
 558 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 559
 560 .. doxygenclass:: simgrid::s4u::Mailbox
 561    :members:
 562    :protected-members:
 563    :undoc-members:
 564 .. _API_s4u_Resource:
 565
 566 =========
 567 Resources
 568 =========
 569
 570 .. _API_s4u_Disk:
 571
 572 =============
 573 ⁣  class Disk
 574 =============
 575
 576 .. doxygenclass:: simgrid::s4u::Disk
 577    :members:
 578    :protected-members:
 579    :undoc-members:
 580
 581
 582
 583 .. _API_s4u_Host:
 584
 585 =============
 586 ⁣  class Host
 587 =============
 588
 589 .. doxygenclass:: simgrid::s4u::Host
 590    :members:
 591    :protected-members:
 592    :undoc-members:
 593
 594 .. _API_s4u_Link:
 595
 596 =============
 597 ⁣  class Link
 598 =============
 599
 600 .. doxygenclass:: simgrid::s4u::Link
 601    :members:
 602    :protected-members:
 603    :undoc-members:
 604
 605 .. _API_s4u_NetZone:
 606
 607 ================
 608 ⁣  class NetZone
 609 ================
 610
 611 .. doxygenclass:: simgrid::s4u::NetZone
 612    :members:
 613    :protected-members:
 614    :undoc-members:
 615
 616 .. _API_s4u_VirtualMachine:
 617
 618 =======================
 619 ⁣  class VirtualMachine
 620 =======================
 621
 622 .. doxygenclass:: simgrid::s4u::VirtualMachine
 623    :members:
 624    :protected-members:
 625    :undoc-members:
 626
 627
 628 .. _API_s4u_Activity:
 629
 630 ==============
 631 class Activity
 632 ==============
 633
 634 .. autodoxyclass:: simgrid::s4u::Activity
 635
 636    **Known subclasses:**
 637    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
 638    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
 639    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
 640    See also the :ref:`section on activities <s4u_Activities>` above.
 641
 642 Querying info about activities
 643 ------------------------------
 644
 645    .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
 646    .. autodoxymethod:: simgrid::s4u::Activity::get_state()
 647    .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
 648    .. autodoxymethod:: simgrid::s4u::Activity::get_impl
 649
 650 Activities lifecycle
 651 --------------------
 652
 653    .. autodoxymethod:: simgrid::s4u::Activity::start
 654    .. autodoxymethod:: simgrid::s4u::Activity::cancel
 655    .. autodoxymethod:: simgrid::s4u::Activity::test
 656    .. autodoxymethod:: simgrid::s4u::Activity::wait
 657    .. autodoxymethod:: simgrid::s4u::Activity::wait_for
 658    .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
 659
 660 .. _API_s4u_Comm:
 661
 662 =============
 663 ⁣  class Comm
 664 =============
 665
 666 .. doxygentypedef:: CommPtr
 667
 668 .. doxygenclass:: simgrid::s4u::Comm
 669    :members:
 670    :protected-members:
 671    :undoc-members:
 672
 673 .. _API_s4u_Exec:
 674
 675 =============
 676 ⁣  class Exec
 677 =============
 678
 679 .. doxygentypedef:: ExecPtr
 680
 681 .. doxygenclass:: simgrid::s4u::Exec
 682    :members:
 683    :protected-members:
 684    :undoc-members:
 685
 686 .. _API_s4u_ExecSeq:
 687
 688 ==================
 689 ⁣    class ExecSeq
 690 ==================
 691
 692 .. doxygentypedef:: ExecSeqPtr
 693
 694 .. doxygenclass:: simgrid::s4u::ExecSeq
 695    :members:
 696    :protected-members:
 697    :undoc-members:
 698
 699 .. _API_s4u_ExecPar:
 700
 701 ==================
 702 ⁣    class ExecPar
 703 ==================
 704
 705 .. doxygentypedef:: ExecParPtr
 706
 707 .. doxygenclass:: simgrid::s4u::ExecPar
 708    :members:
 709    :protected-members:
 710    :undoc-members:
 711
 712 .. _API_s4u_Io:
 713
 714 ===========
 715 ⁣  class Io
 716 ===========
 717
 718 .. doxygentypedef:: IoPtr
 719
 720 .. doxygenclass:: simgrid::s4u::Io
 721    :members:
 722    :protected-members:
 723    :undoc-members:
 724
 725 .. _API_s4u_Synchronizations:
 726
 727 =======================
 728 Synchronization Objects
 729 =======================
 730
 731 .. _API_s4u_Barrier:
 732
 733 ================
 734 ⁣  class Barrier
 735 ================
 736
 737 .. doxygentypedef:: BarrierPtr
 738
 739 .. autodoxyclass:: simgrid::s4u::Barrier
 740
 741    .. tabs::
 742
 743       .. group-tab:: C++
 744
 745          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int count)
 746          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
 747          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
 748
 749
 750 .. _API_s4u_ConditionVariable:
 751
 752 ==========================
 753 ⁣  class ConditionVariable
 754 ==========================
 755
 756 .. doxygentypedef:: ConditionVariablePtr
 757
 758 .. doxygenclass:: simgrid::s4u::ConditionVariable
 759    :members:
 760    :protected-members:
 761    :undoc-members:
 762
 763 .. _API_s4u_Mutex:
 764
 765 ==============
 766 ⁣  class Mutex
 767 ==============
 768
 769 .. doxygentypedef:: MutexPtr
 770
 771 .. doxygenclass:: simgrid::s4u::Mutex
 772    :members:
 773    :protected-members:
 774    :undoc-members:
 775
 776 .. _API_s4u_Semaphore:
 777
 778 ==================
 779 ⁣  class Semaphore
 780 ==================
 781
 782 .. doxygentypedef:: SemaphorePtr
 783
 784 .. doxygenclass:: simgrid::s4u::Semaphore
 785    :members:
 786    :protected-members:
 787    :undoc-members:
 788
 789
 790 C API Reference
 791 ***************
 792
 793 ==============
 794 Main functions
 795 ==============
 796
 797 .. doxygenfunction:: simgrid_init
 798 .. doxygenfunction:: simgrid_get_clock
 799 .. doxygenfunction:: simgrid_load_deployment
 800 .. doxygenfunction:: simgrid_load_platform
 801 .. doxygenfunction:: simgrid_register_default
 802 .. doxygenfunction:: simgrid_register_function
 803 .. doxygenfunction:: simgrid_run
 804
 805 ==================
 806 Condition Variable
 807 ==================
 808
 809 See also the :ref:`C++ API <API_s4u_ConditionVariable>`.
 810
 811 .. doxygenfunction:: sg_cond_init
 812 .. doxygenfunction:: sg_cond_notify_all
 813 .. doxygenfunction:: sg_cond_notify_one
 814 .. doxygenfunction:: sg_cond_wait
 815 .. doxygenfunction:: sg_cond_wait_for
 816
 817 Python API Reference
 818 ********************
 819
 820 The Python API is automatically generated with pybind11. It closely mimicks the C++
 821 API, to which you should refer for more information.
 822
 823 ==========
 824 this_actor
 825 ==========
 826
 827 .. automodule:: simgrid.this_actor
 828    :members:
 829
 830 ===========
 831 Class Actor
 832 ===========
 833
 834 .. autoclass:: simgrid.Actor
 835    :members:
 836
 837 ==========
 838 Class Comm
 839 ==========
 840
 841 .. autoclass:: simgrid.Comm
 842    :members:
 843
 844 ============
 845 Class Engine
 846 ============
 847
 848 .. autoclass:: simgrid.Engine
 849    :members:
 850
 851 ==========
 852 Class Exec
 853 ==========
 854
 855 .. autoclass:: simgrid.Exec
 856    :members:
 857
 858 ==========
 859 Class Host
 860 ==========
 861
 862 .. autoclass:: simgrid.Host
 863    :members:
 864
 865 =============
 866 Class Mailbox
 867 =============
 868
 869 .. autoclass:: simgrid.Mailbox
 870    :members:
 871
 872 .. |hr| raw:: html
 873
 874    <hr />