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 Every kind of activity can be asynchronous:
 173
 174   - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
 175     :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
 176     :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`.
 177   - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
 178     :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
 179     :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`.
 180   - :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
 181     :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
 182   - In the future, it will become possible to have asynchronous IPC
 183     such as asynchronous mutex lock requests.
 184
 185 The following example shows how to have several concurrent
 186 communications ongoing.  First, you have to declare a vector in which
 187 we will store the ongoing communications. It is also useful to have a
 188 vector of mailboxes.
 189
 190 .. literalinclude:: ../../examples/s4u/comm-waitall/s4u-comm-waitall.cpp
 191    :language: c++
 192    :start-after: init-begin
 193    :end-before: init-end
 194    :dedent: 4
 195
 196 Then, you start all the communications that should occur concurrently with
 197 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
 198 Finally, the actor waits for the completion of all of them at once
 199 with
 200 :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
 201
 202 .. literalinclude:: ../../examples/s4u/comm-waitall/s4u-comm-waitall.cpp
 203    :language: c++
 204    :start-after: put-begin
 205    :end-before: put-end
 206    :dedent: 4
 207
 208
 209 =====================
 210 Activities Life cycle
 211 =====================
 212
 213 Sometimes, you want to change the setting of an activity before it even starts.
 214
 215 .. todo:: write this section
 216
 217 .. _s4u_mailbox:
 218
 219 Mailboxes
 220 *********
 221
 222 Please also refer to the :ref:`API reference for s4u::Mailbox
 223 <API_s4u_Mailbox>`.
 224
 225 ===================
 226 What are Mailboxes?
 227 ===================
 228
 229 |API_s4u_Mailboxes|_ are rendez-vous points for network communications,
 230 similar to URLs on which you could post and retrieve data. Actually,
 231 the mailboxes are not involved in the communication once it starts,
 232 but only to find the contact with which you want to communicate.
 233
 234 They are similar to many common things: The phone number, which allows
 235 the caller to find the receiver. The twitter hashtag, which help
 236 senders and receivers to find each others. In TCP, the pair
 237 ``{host name, host port}`` to which you can connect to find your peer.
 238 In HTTP, URLs through which the clients can connect to the servers.
 239 In ZeroMQ, the queues are used to match senders and receivers.
 240
 241 One big difference with most of these systems is that no actor is the
 242 exclusive owner of a mailbox, neither in sending nor in receiving.
 243 Many actors can send into and/or receive from the same mailbox.  TCP
 244 socket ports for example are shared on the sender side but exclusive
 245 on the receiver side (only one process can receive from a given socket
 246 at a given point of time).
 247
 248 A big difference with TCP sockets or MPI communications is that
 249 communications do not start right away after a
 250 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put>`, but wait
 251 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get>`.
 252 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
 253
 254 A big difference with twitter hashtags is that SimGrid does not
 255 offer easy support to broadcast a given message to many
 256 receivers. So that would be like a twitter tag where each message
 257 is consumed by the first receiver.
 258
 259 A big difference with the ZeroMQ queues is that you cannot filter
 260 on the data you want to get from the mailbox. To model such settings
 261 in SimGrid, you'd have one mailbox per potential topic, and subscribe
 262 to each topic individually with a
 263 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async>` on each mailbox.
 264 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any>`
 265 to get the first message on any of the mailbox you are subscribed onto.
 266
 267 The mailboxes are not located on the network, and you can access
 268 them without any latency. The network delay are only related to the
 269 location of the sender and receiver once the match between them is
 270 done on the mailbox. This is just like the phone number that you
 271 can use locally, and the geographical distance only comes into play
 272 once you start the communication by dialing this number.
 273
 274 =====================
 275 How to use Mailboxes?
 276 =====================
 277
 278 You can retrieve any existing mailbox from its name (which is a
 279 unique string, just like a twitter tag). This results in a
 280 versatile mechanism that can be used to build many different
 281 situations.
 282
 283 To model classical socket communications, use "hostname:port" as
 284 mailbox names, and make sure that only one actor reads into a given
 285 mailbox. This does not make it easy to build a perfectly realistic
 286 model of the TCP sockets, but in most cases, this system is too
 287 cumbersome for your simulations anyway. You probably want something
 288 simpler, that turns our to be easy to build with the mailboxes.
 289
 290 Many SimGrid examples use a sort of yellow page system where the
 291 mailbox names are the name of the service (such as "worker",
 292 "master" or "reducer"). That way, you don't have to know where your
 293 peer is located to contact it. You don't even need its name. Its
 294 function is enough for that. This also gives you some sort of load
 295 balancing for free if more than one actor pulls from the mailbox:
 296 the first actor that can deal with the request will handle it.
 297
 298 =========================================
 299 How are put() and get() requests matched?
 300 =========================================
 301
 302 The matching algorithm simple: first come, first serve. When a new
 303 send arrives, it matches the oldest enqueued receive. If no receive is
 304 currently enqueued, then the incoming send is enqueued. As you can
 305 see, the mailbox cannot contain both send and receive requests: all
 306 enqueued requests must be of the same sort.
 307
 308 .. _s4u_receiving_actor:
 309
 310 ===========================
 311 Declaring a Receiving Actor
 312 ===========================
 313
 314 The last twist is that by default in the simulator, the data starts
 315 to be exchanged only when both the sender and the receiver are
 316 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 317 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
 318 In TCP, since you establish connections beforehand, the data starts to
 319 flow as soon as the sender posts it, even if the receiver did not post
 320 its :cpp:func:`put() <simgrid::s4u::Mailbox::put()>` yet.
 321
 322 To model this in SimGrid, you can declare a specific receiver to a
 323 given mailbox (with the function
 324 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
 325 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
 326 posted to that mailbox will start as soon as possible, and the data
 327 will already be there on the receiver host when the receiver actor
 328 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
 329
 330 Note that being permanent receivers of a mailbox prevents actors to be
 331 garbage-collected. If your simulation creates many short-lived actors
 332 that marked as permanent receiver, you should call
 333 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
 334 memory gets properly reclaimed. This call should be at the end of the
 335 actor's function, not in an on_exit callback.
 336
 337 .. _s4u_raii:
 338
 339 Memory Management
 340 *****************
 341
 342 For sake of simplicity, we use `RAII
 343 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
 344 for many classes in S4U. This is an idiom where resources are automatically
 345 managed through the context. Provided that you never manipulate
 346 objects of type Foo directly but always FooPtr references (which are
 347 defined as `boost::intrusive_ptr
 348 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
 349 <Foo>), you will never have to explicitly release the resource that
 350 you use nor to free the memory of unused objects.
 351 Here is a little example:
 352
 353 .. code-block:: cpp
 354
 355    void myFunc()
 356    {
 357      simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
 358
 359      mutex->lock();   // use the mutex as a simple reference
 360      //  bla bla
 361      mutex->unlock();
 362
 363    } // The mutex gets automatically freed because the only existing reference gets out of scope
 364
 365 Note that Mailboxes, Hosts and Links are not handled thought smart
 366 pointers (yet?). This means that it is currently impossible to destroy a
 367 mailbox or a link. You can still destroy a host (but probably
 368 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 369
 370 .. THE EXAMPLES
 371
 372 .. include:: ../../examples/README.rst
 373
 374 API Reference
 375 *************
 376
 377 .. _API_s4u_simulation_object:
 378
 379 ==================
 380 Simulation objects
 381 ==================
 382
 383 .. _API_s4u_Actor:
 384
 385 ==============
 386 ⁣  class Actor
 387 ==============
 388
 389 .. autodoxyclass:: simgrid::s4u::Actor
 390
 391 .. doxygentypedef:: aid_t
 392
 393 Basic management
 394 ----------------
 395
 396 .. tabs::
 397
 398    .. group-tab:: C++
 399
 400       .. code:: C++
 401
 402          #include <simgrid/s4u/Actor.hpp>
 403
 404       .. doxygentypedef:: ActorPtr
 405
 406    .. group-tab:: Python
 407
 408       .. code:: Python
 409
 410          from simgrid import Actor
 411
 412    .. group-tab:: C
 413
 414       .. code:: C
 415
 416          #include <simgrid/actor.h>
 417
 418       .. doxygentypedef:: sg_actor_t
 419       .. cpp:type:: const s4u_Actor* const_sg_actor_t
 420
 421          Pointer to a constant actor object.
 422
 423       .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
 424       .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
 425
 426 Creating actors
 427 ---------------
 428
 429 .. tabs::
 430
 431    .. group-tab:: C++
 432
 433       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
 434       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
 435       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
 436       .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
 437
 438       .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
 439       .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
 440
 441    .. group-tab:: Python
 442
 443       .. automethod:: simgrid.Actor.create
 444
 445    .. group-tab:: C
 446
 447       .. autodoxymethod:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, const char *const *argv)
 448       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
 449       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char *const *argv)
 450
 451       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
 452       .. autodoxymethod:: sg_actor_detach()
 453
 454 Retrieving actors
 455 -----------------
 456
 457 .. tabs::
 458
 459    .. group-tab:: C++
 460
 461       .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
 462       .. autodoxymethod:: simgrid::s4u::Actor::self()
 463
 464    .. group-tab:: Python
 465
 466       .. automethod:: simgrid.Actor.by_pid
 467       .. automethod:: simgrid.Actor.self
 468
 469    .. group-tab:: C
 470
 471       .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
 472       .. autodoxymethod:: sg_actor_self()
 473
 474 Querying info
 475 -------------
 476
 477 .. tabs::
 478
 479    .. group-tab:: C++
 480
 481       .. autodoxymethod:: simgrid::s4u::Actor::get_cname
 482       .. autodoxymethod:: simgrid::s4u::Actor::get_name
 483       .. autodoxymethod:: simgrid::s4u::Actor::get_pid
 484       .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
 485       .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
 486       .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
 487       .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
 488
 489       .. autodoxymethod:: simgrid::s4u::Actor::get_host
 490       .. autodoxymethod:: simgrid::s4u::Actor::set_host
 491
 492       .. autodoxymethod:: simgrid::s4u::Actor::get_refcount
 493       .. autodoxymethod:: simgrid::s4u::Actor::get_impl
 494
 495    .. group-tab:: Python
 496
 497       .. autoattribute:: simgrid.Actor.name
 498       .. autoattribute:: simgrid.Actor.host
 499       .. autoattribute:: simgrid.Actor.pid
 500       .. autoattribute:: simgrid.Actor.ppid
 501
 502    .. group-tab:: C
 503
 504       .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
 505       .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
 506       .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
 507       .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
 508       .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
 509
 510       .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
 511       .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 512
 513       .. autodoxymethod:: sg_actor_get_data(const_sg_actor_t actor)
 514       .. autodoxymethod:: sg_actor_set_data(sg_actor_t actor, void *userdata)
 515
 516 Suspending and resuming actors
 517 ------------------------------
 518
 519 .. tabs::
 520
 521    .. group-tab:: C++
 522
 523       .. autodoxymethod:: simgrid::s4u::Actor::suspend()
 524       .. autodoxymethod:: simgrid::s4u::Actor::resume()
 525       .. autodoxymethod:: simgrid::s4u::Actor::is_suspended
 526
 527    .. group-tab:: Python
 528
 529       .. automethod:: simgrid.Actor.resume
 530       .. automethod:: simgrid.Actor.suspend
 531       .. automethod:: simgrid.Actor.is_suspended
 532
 533    .. group-tab:: C
 534
 535       .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
 536       .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
 537       .. autodoxymethod:: sg_actor_is_suspended(const_sg_actor_t actor)
 538
 539 Specifying when actors should terminate
 540 ---------------------------------------
 541
 542 .. tabs::
 543
 544    .. group-tab:: C++
 545
 546       .. autodoxymethod:: simgrid::s4u::Actor::kill()
 547       .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
 548       .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
 549       .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time
 550
 551       .. autodoxymethod:: simgrid::s4u::Actor::restart()
 552       .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
 553       .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
 554
 555    .. group-tab:: Python
 556
 557       .. automethod:: simgrid.Actor.kill
 558       .. automethod:: simgrid.Actor.kill_all
 559
 560       .. automethod:: simgrid.Actor.daemonize
 561       .. automethod:: simgrid.Actor.is_daemon
 562
 563    .. group-tab:: C
 564
 565       .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
 566       .. autodoxymethod:: sg_actor_kill_all()
 567       .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 568
 569       .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
 570       .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
 571       .. autodoxymethod:: sg_actor_is_daemon
 572
 573 .. _API_s4u_Actor_end:
 574
 575 Reacting to the end of actors
 576 -----------------------------
 577
 578 .. tabs::
 579
 580    .. group-tab:: C++
 581
 582       .. autodoxymethod:: simgrid::s4u::Actor::on_exit
 583       .. autodoxymethod:: simgrid::s4u::Actor::join() const
 584       .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout) const
 585       .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
 586
 587    .. group-tab:: Python
 588
 589       .. automethod:: simgrid.Actor.join
 590
 591    .. group-tab:: C
 592
 593       .. autodoxymethod:: sg_actor_join(const_sg_actor_t actor, double timeout)
 594       .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 595
 596 Signals
 597 -------
 598
 599 .. tabs::
 600
 601    .. group-tab:: C++
 602
 603       .. autodoxyvar:: simgrid::s4u::Actor::on_creation
 604       .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
 605       .. cpp:var:: xbt::signal<void(const simgrid::s4u::Actor&, const simgrid::s4u::Host & previous_location)> Actor::on_host_change
 606
 607          Signal fired when an actor is migrated from one host to another.
 608
 609       .. autodoxyvar:: simgrid::s4u::Actor::on_resume
 610       .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
 611       .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
 612       .. autodoxyvar:: simgrid::s4u::Actor::on_termination
 613       .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
 614
 615 .. _API_s4u_this_actor:
 616
 617 ====================
 618 ⁣  The current actor
 619 ====================
 620
 621 These functions can be used in your user code to interact with the actor
 622 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
 623 Using these functions can greatly improve the code readability.
 624
 625 Querying info
 626 -------------
 627
 628 .. tabs::
 629
 630    .. group-tab:: C++
 631
 632       .. autodoxymethod:: simgrid::s4u::this_actor::get_cname()
 633       .. autodoxymethod:: simgrid::s4u::this_actor::get_name()
 634       .. autodoxymethod:: simgrid::s4u::this_actor::get_pid()
 635       .. autodoxymethod:: simgrid::s4u::this_actor::get_ppid()
 636       .. autodoxymethod:: simgrid::s4u::this_actor::is_maestro()
 637
 638       .. autodoxymethod:: simgrid::s4u::this_actor::get_host()
 639       .. autodoxymethod:: simgrid::s4u::this_actor::set_host(Host *new_host)
 640
 641    .. group-tab:: Python
 642
 643       .. autofunction:: simgrid.this_actor.get_host
 644       .. autofunction:: simgrid.this_actor.set_host
 645
 646    .. group-tab:: C
 647
 648       .. autodoxymethod:: sg_actor_self_get_data()
 649       .. autodoxymethod:: sg_actor_self_set_data(void *data)
 650       .. autodoxymethod:: sg_actor_self_get_name()
 651       .. autodoxymethod:: sg_actor_self_get_pid()
 652       .. autodoxymethod:: sg_actor_self_get_ppid()
 653       .. autodoxymethod:: sg_host_self()
 654       .. autodoxymethod:: sg_host_self_get_name()
 655
 656 Suspending and resuming
 657 -----------------------
 658
 659 .. tabs::
 660
 661    .. group-tab:: C++
 662
 663       .. autodoxymethod:: simgrid::s4u::this_actor::suspend()
 664       .. autodoxymethod:: simgrid::s4u::this_actor::yield()
 665
 666    .. group-tab:: Python
 667
 668       .. autofunction:: simgrid.this_actor.suspend
 669       .. autofunction:: simgrid.this_actor.yield_
 670
 671    .. group-tab:: C
 672
 673       .. autodoxymethod:: sg_actor_yield()
 674
 675 Logging messages
 676 ----------------
 677
 678 .. tabs::
 679
 680    .. group-tab:: Python
 681
 682        .. autofunction:: simgrid.this_actor.info
 683        .. autofunction:: simgrid.this_actor.error
 684
 685 Sleeping
 686 --------
 687
 688 .. tabs::
 689
 690    .. group-tab:: C++
 691
 692       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(double duration)
 693       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
 694       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
 695       .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
 696
 697    .. group-tab:: Python
 698
 699       .. autofunction:: simgrid.this_actor.sleep_for
 700       .. autofunction:: simgrid.this_actor.sleep_until
 701
 702    .. group-tab:: C
 703
 704       .. autodoxymethod:: sg_actor_sleep_for(double duration)
 705
 706 Simulating executions
 707 ---------------------
 708
 709 Simulate the execution of some code on this actor. You can either simulate
 710 parallel or sequential code, and you can either block upon the termination of
 711 the execution, or start an asynchronous activity.
 712
 713 .. tabs::
 714
 715    .. group-tab:: C++
 716
 717       .. autodoxymethod:: simgrid::s4u::this_actor::exec_async
 718       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 719       .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
 720       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
 721       .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
 722       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
 723       .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
 724
 725    .. group-tab:: Python
 726
 727       .. autofunction:: simgrid.this_actor.exec_init
 728       .. autofunction:: simgrid.this_actor.execute
 729
 730    .. group-tab:: C
 731
 732       .. autodoxymethod:: sg_actor_execute(double flops)
 733       .. autodoxymethod:: sg_actor_execute_with_priority(double flops, double priority)
 734       .. autodoxymethod:: sg_actor_exec_init(double computation_amount)
 735       .. autodoxymethod:: sg_actor_exec_async(double computation_amount)
 736
 737 Exiting
 738 -------
 739
 740 .. tabs::
 741
 742    .. group-tab:: C++
 743
 744       .. autodoxymethod:: simgrid::s4u::this_actor::exit()
 745       .. autodoxymethod:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
 746
 747    .. group-tab:: Python
 748
 749       .. autofunction:: simgrid.this_actor.exit
 750       .. autofunction:: simgrid.this_actor.on_exit
 751
 752 .. _API_s4u_Engine:
 753
 754 ====================
 755 ⁣  Simulation Engine
 756 ====================
 757
 758 .. autodoxyclass:: simgrid::s4u::Engine
 759
 760 Initialization
 761 --------------
 762
 763 .. tabs::
 764
 765    .. group-tab:: C++
 766
 767       .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
 768       .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
 769       .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
 770       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
 771       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
 772       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
 773       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
 774       .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
 775
 776       .. autodoxymethod:: simgrid::s4u::Engine::load_deployment
 777       .. autodoxymethod:: simgrid::s4u::Engine::load_platform
 778       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
 779       .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
 780       .. autodoxymethod:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
 781       .. autodoxymethod:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
 782
 783       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
 784       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
 785       .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
 786
 787    .. group-tab:: Python
 788
 789        .. automethod:: simgrid.Engine.load_deployment
 790        .. automethod:: simgrid.Engine.load_platform
 791        .. automethod:: simgrid.Engine.register_actor
 792
 793    .. group-tab:: C
 794
 795       .. autodoxymethod:: simgrid_init
 796
 797       .. autodoxymethod:: simgrid_load_deployment
 798       .. autodoxymethod:: simgrid_load_platform
 799       .. autodoxymethod:: simgrid_register_default
 800       .. autodoxymethod:: simgrid_register_function
 801
 802 Run the simulation
 803 ------------------
 804
 805 .. tabs::
 806
 807    .. group-tab:: C++
 808
 809       .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
 810       .. autodoxymethod:: simgrid::s4u::Engine::run
 811
 812    .. group-tab:: Python
 813
 814       .. automethod:: simgrid.Engine.get_clock
 815       .. automethod:: simgrid.Engine.run
 816
 817    .. group-tab:: C
 818
 819       .. autodoxymethod:: simgrid_get_clock
 820       .. autodoxymethod:: simgrid_run
 821
 822 Retrieving actors
 823 -----------------
 824
 825 .. tabs::
 826
 827    .. group-tab:: C++
 828
 829       .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count
 830       .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors
 831       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors
 832
 833    .. group-tab:: C
 834
 835       .. autodoxymethod:: simgrid_get_actor_count()
 836
 837 Retrieving hosts
 838 ----------------
 839
 840 .. tabs::
 841
 842    .. group-tab:: C++
 843
 844       .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts
 845       .. autodoxymethod:: simgrid::s4u::Engine::get_host_count
 846       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts
 847       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name
 848       .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null
 849
 850    .. group-tab:: Python
 851
 852       .. automethod:: simgrid.Engine.get_all_hosts
 853
 854    .. group-tab:: C
 855
 856       See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
 857
 858 Retrieving links
 859 ----------------
 860
 861 .. tabs::
 862
 863    .. group-tab:: C++
 864
 865       .. autodoxymethod:: simgrid::s4u::Engine::get_all_links
 866       .. autodoxymethod:: simgrid::s4u::Engine::get_link_count
 867       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
 868       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name
 869       .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null
 870
 871 Interacting with the routing
 872 ----------------------------
 873
 874 .. tabs::
 875
 876    .. group-tab:: C++
 877
 878       .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints
 879       .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones
 880       .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
 881       .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root
 882       .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null
 883       .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null
 884       .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
 885
 886 Signals
 887 -------
 888
 889 .. tabs::
 890
 891    .. group-tab:: C++
 892
 893       .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
 894       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
 895       .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
 896       .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
 897       .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
 898
 899 .. _API_s4u_Mailbox:
 900
 901 ================
 902 ⁣  class Mailbox
 903 ================
 904
 905 .. autodoxyclass:: simgrid::s4u::Mailbox
 906
 907 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 908
 909 Basic management
 910 ----------------
 911
 912 .. tabs::
 913
 914    .. group-tab:: C++
 915
 916       .. code-block:: C++
 917
 918          #include <simgrid/s4u/Mailbox.hpp>
 919
 920       Note that there is no MailboxPtr type, and that you cannot use the RAII
 921       idiom on mailboxes because they are internal objects to the simulation
 922       engine. Once created, there is no way to destroy a mailbox before the end
 923       of the simulation.
 924
 925       .. autodoxymethod:: simgrid::s4u::Mailbox::by_name(const std::string &name)
 926
 927    .. group-tab:: Python
 928
 929       .. automethod:: simgrid.Mailbox.by_name
 930
 931       .. code-block:: C
 932
 933          #include <simgrid/s4u/mailbox.h>
 934
 935       .. autodoxymethod:: sg_mailbox_by_name(const char *alias)
 936
 937    .. group-tab:: C
 938
 939 Querying info
 940 -------------
 941
 942 .. tabs::
 943
 944    .. group-tab:: C++
 945
 946       .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname
 947       .. autodoxymethod:: simgrid::s4u::Mailbox::get_name
 948
 949    .. group-tab:: Python
 950
 951       .. autoattribute:: simgrid.Mailbox.name
 952
 953 Sending data
 954 ------------
 955
 956 .. tabs::
 957
 958    .. group-tab:: C++
 959
 960       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
 961       .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
 962       .. autodoxymethod:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
 963       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init()
 964       .. autodoxymethod:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
 965
 966    .. group-tab:: Python
 967
 968       .. automethod:: simgrid.Mailbox.put
 969       .. automethod:: simgrid.Mailbox.put_async
 970
 971    .. group-tab: C
 972
 973       .. autodoxymethod:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
 974       .. autodoxymethod:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
 975       .. autodoxymethod:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
 976
 977
 978 Receiving data
 979 --------------
 980
 981 .. tabs::
 982
 983    .. group-tab:: C++
 984
 985       .. autodoxymethod:: simgrid::s4u::Mailbox::empty
 986       .. autodoxymethod:: simgrid::s4u::Mailbox::front
 987       .. autodoxymethod:: simgrid::s4u::Mailbox::get()
 988       .. autodoxymethod:: simgrid::s4u::Mailbox::get(double timeout)
 989       .. autodoxymethod:: simgrid::s4u::Mailbox::get_async(T **data)
 990       .. autodoxymethod:: simgrid::s4u::Mailbox::get_init()
 991       .. autodoxymethod:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
 992       .. autodoxymethod:: simgrid::s4u::Mailbox::listen
 993       .. autodoxymethod:: simgrid::s4u::Mailbox::ready
 994
 995    .. group-tab:: Python
 996
 997        .. automethod:: simgrid.Mailbox.get
 998
 999    .. group-tab:: C
1000
1001       .. autodoxymethod:: sg_mailbox_get(sg_mailbox_t mailbox)
1002       .. autodoxymethod:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1003       .. autodoxymethod:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1004       .. autodoxymethod:: sg_mailbox_listen(const char *alias)
1005
1006 Receiving actor
1007 ---------------
1008
1009 See :ref:`s4u_receiving_actor`.
1010
1011 .. tabs::
1012
1013    .. group-tab:: C++
1014
1015       .. autodoxymethod:: simgrid::s4u::Mailbox::get_receiver
1016       .. autodoxymethod:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1017
1018    .. group-tab:: C
1019
1020       .. autodoxymethod:: sg_mailbox_set_receiver(const char *alias)
1021
1022 .. _API_s4u_Resource:
1023
1024 =========
1025 Resources
1026 =========
1027
1028 .. _API_s4u_Disk:
1029
1030 =============
1031 ⁣  class Disk
1032 =============
1033
1034 .. autodoxyclass:: simgrid::s4u::Disk
1035
1036 Basic management
1037 ----------------
1038
1039 .. tabs::
1040
1041    .. group-tab:: C++
1042
1043       .. code-block:: C++
1044
1045          #include <simgrid/s4u/Disk.hpp>
1046
1047       Note that there is no DiskPtr type, and that you cannot use the RAII
1048       idiom on disks because SimGrid does not allow (yet) to create nor
1049       destroy resources once the simulation is started.
1050
1051
1052 Querying info
1053 -------------
1054
1055 .. tabs::
1056
1057    .. group-tab:: C++
1058
1059       .. autodoxymethod:: simgrid::s4u::Disk::get_cname() const
1060       .. autodoxymethod:: simgrid::s4u::Disk::get_host() const
1061       .. autodoxymethod:: simgrid::s4u::Disk::get_name() const
1062       .. autodoxymethod:: simgrid::s4u::Disk::get_properties() const
1063       .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key) const
1064       .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth() const
1065       .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth() const
1066       .. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1067
1068 I/O operations
1069 --------------
1070
1071 .. tabs::
1072
1073    .. group-tab:: C++
1074
1075       .. autodoxymethod:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type)
1076       .. autodoxymethod:: simgrid::s4u::Disk::read(sg_size_t size)
1077       .. autodoxymethod:: simgrid::s4u::Disk::read_async(sg_size_t size)
1078       .. autodoxymethod:: simgrid::s4u::Disk::write(sg_size_t size)
1079       .. autodoxymethod:: simgrid::s4u::Disk::write_async(sg_size_t size)
1080
1081 Signals
1082 -------
1083
1084 .. tabs::
1085
1086    .. group-tab:: C++
1087
1088       .. autodoxyvar:: simgrid::s4u::Disk::on_creation
1089       .. autodoxyvar:: simgrid::s4u::Disk::on_destruction
1090       .. autodoxyvar:: simgrid::s4u::Disk::on_state_change
1091
1092
1093 .. _API_s4u_Host:
1094
1095 =============
1096 ⁣  class Host
1097 =============
1098
1099 .. autodoxyclass:: simgrid::s4u::Host
1100
1101 Basic management
1102 ----------------
1103
1104 .. tabs::
1105
1106    .. group-tab:: C++
1107
1108       .. code-block:: C++
1109
1110          #include <simgrid/s4u/Host.hpp>
1111
1112       Note that there is no HostPtr type, and that you cannot use the RAII
1113       idiom on hosts because SimGrid does not allow (yet) to create nor
1114       destroy resources once the simulation is started.
1115
1116       .. autodoxymethod:: simgrid::s4u::Host::destroy()
1117
1118    .. group-tab:: Python
1119
1120       .. code:: Python
1121
1122          from simgrid import Host
1123
1124    .. group-tab:: C
1125
1126       .. code:: C
1127
1128          #include <simgrid/host.h>
1129
1130       .. doxygentypedef:: sg_host_t
1131       .. cpp:type:: const s4u_Host* const_sg_host_t
1132
1133          Pointer to a constant host object.
1134
1135 Retrieving hosts
1136 ----------------
1137
1138 .. tabs::
1139
1140    .. group-tab:: C++
1141
1142       See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1143
1144       .. autodoxymethod:: simgrid::s4u::Host::by_name(const std::string &name)
1145       .. autodoxymethod:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1146       .. autodoxymethod:: simgrid::s4u::Host::current()
1147
1148    .. group-tab:: Python
1149
1150       See also :py:func:`simgrid.Engine.get_all_hosts`.
1151
1152       .. automethod:: simgrid.Host.by_name
1153       .. automethod:: simgrid.Host.current
1154
1155    .. group-tab:: C
1156
1157       .. autodoxymethod:: sg_host_by_name(const char *name)
1158       .. autodoxymethod:: sg_host_count()
1159       .. autodoxymethod:: sg_host_list()
1160       .. autodoxymethod:: sg_hosts_as_dynar()
1161
1162 Querying info
1163 -------------
1164
1165 .. tabs::
1166
1167    .. group-tab:: C++
1168
1169       .. autodoxymethod:: simgrid::s4u::Host::get_cname() const
1170       .. autodoxymethod:: simgrid::s4u::Host::get_core_count() const
1171       .. autodoxymethod:: simgrid::s4u::Host::get_name() const
1172       .. autodoxymethod:: simgrid::s4u::Host::get_available_speed() const
1173       .. autodoxymethod:: simgrid::s4u::Host::get_load() const
1174       .. autodoxymethod:: simgrid::s4u::Host::get_speed() const
1175
1176    .. group-tab:: Python
1177
1178       .. autoattribute:: simgrid.Host.name
1179       .. autoattribute:: simgrid.Host.load
1180       .. autoattribute:: simgrid.Host.pstate
1181       .. autoattribute:: simgrid.Host.speed
1182
1183    .. group-tab:: C
1184
1185       .. autodoxymethod:: sg_host_core_count(const_sg_host_t host)
1186       .. autodoxymethod:: sg_host_dump(const_sg_host_t ws)
1187       .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
1188       .. autodoxymethod:: sg_host_get_load(const_sg_host_t host)
1189       .. autodoxymethod:: sg_host_get_speed(const_sg_host_t host)
1190
1191 User data and properties
1192 ------------------------
1193
1194 .. tabs::
1195
1196    .. group-tab:: C++
1197
1198       .. autodoxymethod:: simgrid::s4u::Host::get_properties() const
1199       .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key) const
1200       .. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1201       .. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1202
1203    .. group-tab:: C
1204
1205       .. autodoxymethod:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1206       .. autodoxymethod:: sg_host_get_properties(const_sg_host_t host)
1207       .. autodoxymethod:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1208       .. autodoxymethod:: sg_host_extension_create(void(*deleter)(void *))
1209       .. autodoxymethod:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1210
1211 Retrieving components
1212 ---------------------
1213
1214 .. tabs::
1215
1216    .. group-tab:: C++
1217
1218       .. autodoxymethod:: simgrid::s4u::Host::add_disk(const Disk *disk)
1219       .. autodoxymethod:: simgrid::s4u::Host::get_actor_count() const
1220       .. autodoxymethod:: simgrid::s4u::Host::get_all_actors() const
1221       .. autodoxymethod:: simgrid::s4u::Host::get_disks() const
1222       .. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1223
1224    .. group-tab:: C
1225
1226       .. autodoxymethod:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1227
1228 On/Off
1229 ------
1230
1231 .. tabs::
1232
1233    .. group-tab:: C++
1234
1235       .. autodoxymethod:: simgrid::s4u::Host::is_on() const
1236       .. autodoxymethod:: simgrid::s4u::Host::turn_off()
1237       .. autodoxymethod:: simgrid::s4u::Host::turn_on()
1238
1239    .. group-tab:: C
1240
1241       .. autodoxymethod:: sg_host_is_on(const_sg_host_t host)
1242       .. autodoxymethod:: sg_host_turn_off(sg_host_t host)
1243       .. autodoxymethod:: sg_host_turn_on(sg_host_t host)
1244
1245 DVFS
1246 ----
1247
1248 .. tabs::
1249
1250    .. group-tab:: C++
1251
1252       .. autodoxymethod:: simgrid::s4u::Host::get_pstate() const
1253       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count() const
1254       .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
1255       .. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
1256       .. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1257       .. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1258
1259    .. group-tab:: Python
1260
1261       .. automethod:: simgrid.Host.get_pstate_count
1262       .. automethod:: simgrid.Host.get_pstate_speed
1263
1264    .. group-tab:: C
1265
1266       .. autodoxymethod:: sg_host_get_available_speed(const_sg_host_t host)
1267       .. autodoxymethod:: sg_host_get_nb_pstates(const_sg_host_t host)
1268       .. autodoxymethod:: sg_host_get_pstate(const_sg_host_t host)
1269       .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1270       .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
1271
1272 Execution
1273 ---------
1274
1275 .. tabs::
1276
1277    .. group-tab:: C++
1278
1279       .. autodoxymethod:: simgrid::s4u::Host::exec_async
1280       .. autodoxymethod:: simgrid::s4u::Host::execute(double flops) const
1281       .. autodoxymethod:: simgrid::s4u::Host::execute(double flops, double priority) const
1282
1283 Platform and routing
1284 --------------------
1285
1286 .. tabs::
1287
1288    .. group-tab:: C++
1289
1290       .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
1291       .. autodoxymethod:: simgrid::s4u::Host::get_netpoint() const
1292       .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1293       .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
1294       .. autodoxymethod:: simgrid::s4u::Host::sendto(Host *dest, double byte_amount)
1295       .. autodoxymethod:: simgrid::s4u::Host::sendto_async(Host *dest, double byte_amount)
1296
1297    .. group-tab:: C
1298
1299       .. autodoxymethod:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1300       .. autodoxymethod:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1301       .. autodoxymethod:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1302       .. autodoxymethod:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1303
1304 Signals
1305 -------
1306
1307 .. tabs::
1308
1309    .. group-tab:: C++
1310
1311       .. autodoxyvar:: simgrid::s4u::Host::on_creation
1312       .. autodoxyvar:: simgrid::s4u::Host::on_destruction
1313       .. autodoxyvar:: simgrid::s4u::Host::on_speed_change
1314       .. autodoxyvar:: simgrid::s4u::Host::on_state_change
1315
1316 .. _API_s4u_Link:
1317
1318 =============
1319 ⁣  class Link
1320 =============
1321
1322 .. autodoxyclass:: simgrid::s4u::Link
1323
1324 Basic management
1325 ----------------
1326
1327 .. tabs::
1328
1329    .. group-tab:: C++
1330
1331       .. code-block:: C++
1332
1333          #include <simgrid/s4u/Link.hpp>
1334
1335       Note that there is no LinkPtr type, and that you cannot use the RAII
1336       idiom on hosts because SimGrid does not allow (yet) to create nor
1337       destroy resources once the simulation is started.
1338
1339    .. group-tab:: Python
1340
1341       .. code:: Python
1342
1343          from simgrid import Link
1344
1345    .. group-tab:: C
1346
1347       .. code:: C
1348
1349          #include <simgrid/link.h>
1350
1351       .. doxygentypedef:: sg_link_t
1352       .. cpp:type:: const s4u_Link* const_sg_link_t
1353
1354          Pointer to a constant link object.
1355
1356 Retrieving links
1357 ----------------
1358
1359 .. tabs::
1360
1361    .. group-tab:: C++
1362
1363       See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1364
1365       .. autodoxymethod:: simgrid::s4u::Link::by_name(const std::string &name)
1366       .. autodoxymethod:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1367
1368    .. group-tab:: C
1369
1370       .. autodoxymethod:: sg_link_by_name(const char *name)
1371       .. autodoxymethod:: sg_link_count()
1372       .. autodoxymethod:: sg_link_list()
1373
1374 Querying info
1375 --------------
1376
1377 .. tabs::
1378
1379    .. group-tab:: C++
1380
1381       .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth() const
1382       .. autodoxymethod:: simgrid::s4u::Link::get_cname() const
1383       .. autodoxymethod:: simgrid::s4u::Link::get_latency() const
1384       .. autodoxymethod:: simgrid::s4u::Link::get_name() const
1385       .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy() const
1386       .. autodoxymethod:: simgrid::s4u::Link::get_usage() const
1387       .. autodoxymethod:: simgrid::s4u::Link::is_used() const
1388
1389    .. group-tab:: C
1390
1391       .. autodoxymethod:: sg_link_get_bandwidth(const_sg_link_t link)
1392       .. autodoxymethod:: sg_link_get_latency(const_sg_link_t link)
1393       .. autodoxymethod:: sg_link_get_name(const_sg_link_t link)
1394       .. autodoxymethod:: sg_link_is_shared(const_sg_link_t link)
1395
1396 Modifying characteristics
1397 -------------------------
1398
1399 .. tabs::
1400
1401    .. group-tab:: C++
1402
1403       .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth(double value)
1404       .. autodoxymethod:: simgrid::s4u::Link::set_latency(double value)
1405
1406    .. group-tab:: C
1407
1408       .. autodoxymethod:: sg_link_set_bandwidth(sg_link_t link, double value)
1409       .. autodoxymethod:: sg_link_set_latency(sg_link_t link, double value)
1410
1411 User data and properties
1412 ------------------------
1413
1414 .. tabs::
1415
1416    .. group-tab:: C++
1417
1418       .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key) const
1419       .. autodoxymethod:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1420
1421    .. group-tab:: C
1422
1423       .. autodoxymethod:: sg_link_get_data(const_sg_link_t link)
1424       .. autodoxymethod:: sg_link_set_data(sg_link_t link, void *data)
1425
1426 On/Off
1427 ------
1428
1429 .. tabs::
1430
1431    .. group-tab:: C++
1432
1433       See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1434
1435       .. autodoxymethod:: simgrid::s4u::Link::is_on() const
1436       .. autodoxymethod:: simgrid::s4u::Link::turn_off()
1437       .. autodoxymethod:: simgrid::s4u::Link::turn_on()
1438
1439 Dynamic profiles
1440 ----------------
1441
1442 See :ref:`howto_churn` for more details.
1443
1444 .. tabs::
1445
1446    .. group-tab:: C++
1447
1448       .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1449       .. autodoxymethod:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1450       .. autodoxymethod:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1451
1452 WIFI links
1453 ----------
1454
1455 .. tabs::
1456
1457    .. group-tab:: C++
1458
1459       .. autodoxymethod:: simgrid::s4u::Link::set_host_wifi_rate
1460
1461 Signals
1462 -------
1463
1464 .. tabs::
1465
1466    .. group-tab:: C++
1467
1468       .. autodoxyvar:: simgrid::s4u::Link::on_bandwidth_change
1469       .. cpp:var:: xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> Link::on_communicate
1470       .. autodoxyvar:: simgrid::s4u::Link::on_communication_state_change
1471       .. autodoxyvar:: simgrid::s4u::Link::on_creation
1472       .. autodoxyvar:: simgrid::s4u::Link::on_destruction
1473       .. autodoxyvar:: simgrid::s4u::Link::on_state_change
1474
1475 .. _API_s4u_NetZone:
1476
1477 ================
1478 ⁣  class NetZone
1479 ================
1480
1481 .. autodoxyclass:: simgrid::s4u::NetZone
1482
1483 Basic management
1484 ----------------
1485
1486 .. tabs::
1487
1488    .. group-tab:: C++
1489
1490       .. code-block:: C++
1491
1492          #include <simgrid/s4u/NetZone.hpp>
1493
1494       Note that there is no NetZonePtr type, and that you cannot use the RAII
1495       idiom on network zones because SimGrid does not allow (yet) to create nor
1496       destroy resources once the simulation is started.
1497
1498    .. group-tab:: C
1499
1500       .. code:: C
1501
1502          #include <simgrid/zone.h>
1503
1504       .. doxygentypedef:: sg_netzone_t
1505       .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1506
1507          Pointer to a constant network zone object.
1508
1509 Retrieving zones
1510 ----------------
1511
1512 .. tabs::
1513
1514    .. group-tab:: C++
1515
1516       See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1517       :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1518       :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1519
1520    .. group-tab:: C
1521
1522       .. autodoxymethod:: sg_zone_get_by_name(const char *name)
1523       .. autodoxymethod:: sg_zone_get_root()
1524
1525 Querying info
1526 --------------
1527
1528 .. tabs::
1529
1530    .. group-tab:: C++
1531
1532       .. autodoxymethod:: simgrid::s4u::NetZone::get_cname() const
1533       .. autodoxymethod:: simgrid::s4u::NetZone::get_name() const
1534
1535    .. group-tab:: C
1536
1537       .. autodoxymethod:: sg_zone_get_name(const_sg_netzone_t zone)
1538
1539 User data and properties
1540 ------------------------
1541
1542 .. tabs::
1543
1544    .. group-tab:: C++
1545
1546       .. autodoxymethod:: simgrid::s4u::NetZone::get_properties() const
1547       .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1548       .. autodoxymethod:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1549
1550    .. group-tab:: C
1551
1552       .. autodoxymethod:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1553       .. autodoxymethod:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1554
1555 Retrieving components
1556 ---------------------
1557
1558 .. tabs::
1559
1560    .. group-tab:: C++
1561
1562       .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts() const
1563       .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count() const
1564
1565    .. group-tab:: C
1566
1567       .. autodoxymethod:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1568
1569 Routing data
1570 ------------
1571
1572 .. tabs::
1573
1574    .. group-tab:: C++
1575
1576       .. autodoxymethod:: simgrid::s4u::NetZone::add_bypass_route
1577       .. autodoxymethod:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1578       .. autodoxymethod:: simgrid::s4u::NetZone::add_route
1579       .. autodoxymethod:: simgrid::s4u::NetZone::get_children() const
1580       .. autodoxymethod:: simgrid::s4u::NetZone::get_father()
1581
1582    .. group-tab:: C
1583
1584       .. autodoxymethod:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1585
1586 Signals
1587 -------
1588
1589 .. tabs::
1590
1591   .. group-tab:: C++
1592
1593      .. autodoxyvar:: simgrid::s4u::NetZone::on_creation
1594      .. autodoxyvar:: simgrid::s4u::NetZone::on_route_creation
1595      .. autodoxyvar:: simgrid::s4u::NetZone::on_seal
1596
1597 .. _API_s4u_VirtualMachine:
1598
1599 =======================
1600 ⁣  class VirtualMachine
1601 =======================
1602
1603
1604 .. autodoxyclass:: simgrid::s4u::VirtualMachine
1605
1606 Basic management
1607 ----------------
1608 .. tabs::
1609
1610    .. group-tab:: C++
1611
1612       .. code-block:: C++
1613
1614          #include <simgrid/s4u/VirtualMachine.hpp>
1615
1616       Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1617       idiom on virtual machines. There is no good reason for that and should change in the future.
1618
1619    .. group-tab:: C
1620
1621       .. code:: C
1622
1623          #include <simgrid/vm.h>
1624
1625       .. doxygentypedef:: sg_vm_t
1626       .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1627
1628          Pointer to a constant virtual machine object.
1629
1630 Creating VMs
1631 ------------
1632
1633 .. tabs::
1634
1635    .. group-tab:: C++
1636
1637       .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1638       .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1639       .. autodoxymethod:: simgrid::s4u::VirtualMachine::destroy
1640
1641    .. group-tab:: C
1642
1643       .. autodoxymethod:: sg_vm_create_core
1644       .. autodoxymethod:: sg_vm_create_multicore
1645       .. autodoxymethod:: sg_vm_destroy
1646
1647 Querying info
1648 --------------
1649
1650 .. tabs::
1651
1652    .. group-tab:: C++
1653
1654       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_pm() const
1655       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_ramsize() const
1656       .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_state() const
1657
1658       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1659       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1660       .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1661
1662    .. group-tab:: C
1663
1664       .. autodoxymethod:: sg_vm_get_ramsize(const_sg_vm_t vm)
1665       .. autodoxymethod:: sg_vm_set_bound(sg_vm_t vm, double bound)
1666       .. autodoxymethod:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1667
1668       .. autodoxymethod:: sg_vm_get_name
1669       .. autodoxymethod:: sg_vm_get_pm
1670       .. autodoxymethod:: sg_vm_is_created
1671       .. autodoxymethod:: sg_vm_is_running
1672       .. autodoxymethod:: sg_vm_is_suspended
1673
1674 Life cycle
1675 ----------
1676
1677 .. tabs::
1678
1679    .. group-tab:: C++
1680
1681       .. autodoxymethod:: simgrid::s4u::VirtualMachine::resume()
1682       .. autodoxymethod:: simgrid::s4u::VirtualMachine::shutdown()
1683       .. autodoxymethod:: simgrid::s4u::VirtualMachine::start()
1684       .. autodoxymethod:: simgrid::s4u::VirtualMachine::suspend()
1685
1686    .. group-tab:: C
1687
1688       .. autodoxymethod:: sg_vm_start
1689       .. autodoxymethod:: sg_vm_suspend
1690       .. autodoxymethod:: sg_vm_resume
1691       .. autodoxymethod:: sg_vm_shutdown
1692
1693 Signals
1694 -------
1695
1696 .. tabs::
1697
1698    .. group-tab:: C++
1699
1700       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_end
1701       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_start
1702       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_resume
1703       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_shutdown
1704       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_start
1705       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_started
1706       .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_suspend
1707
1708 .. _API_s4u_Activity:
1709
1710 ==============
1711 class Activity
1712 ==============
1713
1714 .. autodoxyclass:: simgrid::s4u::Activity
1715
1716    **Known subclasses:**
1717    :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1718    :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1719    :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1720    See also the :ref:`section on activities <s4u_Activities>` above.
1721
1722 Basic management
1723 ----------------
1724
1725 .. tabs::
1726
1727    .. group-tab:: C++
1728
1729       .. code-block:: C++
1730
1731          #include <simgrid/s4u/Activity.hpp>
1732
1733       .. doxygentypedef:: ActivityPtr
1734
1735 Querying info
1736 -------------
1737
1738 .. tabs::
1739
1740    .. group-tab:: C++
1741
1742       .. autodoxymethod:: simgrid::s4u::Activity::get_cname
1743       .. autodoxymethod:: simgrid::s4u::Activity::get_name
1744       .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() const
1745       .. autodoxymethod:: simgrid::s4u::Activity::get_state() const
1746       .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
1747       .. autodoxymethod:: simgrid::s4u::Activity::set_state(Activity::State state)
1748
1749
1750 Activities life cycle
1751 ---------------------
1752
1753 .. tabs::
1754
1755    .. group-tab:: C++
1756
1757       .. autodoxymethod:: simgrid::s4u::Activity::start
1758       .. autodoxymethod:: simgrid::s4u::Activity::cancel
1759       .. autodoxymethod:: simgrid::s4u::Activity::test
1760       .. autodoxymethod:: simgrid::s4u::Activity::wait
1761       .. autodoxymethod:: simgrid::s4u::Activity::wait_for
1762       .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
1763       .. autodoxymethod:: simgrid::s4u::Activity::vetoable_start()
1764
1765 Suspending and resuming an activity
1766 -----------------------------------
1767
1768 .. tabs::
1769
1770    .. group-tab:: C++
1771
1772       .. autodoxymethod:: simgrid::s4u::Activity::suspend
1773       .. autodoxymethod:: simgrid::s4u::Activity::resume
1774       .. autodoxymethod:: simgrid::s4u::Activity::is_suspended
1775
1776 .. _API_s4u_Comm:
1777
1778 =============
1779 ⁣  class Comm
1780 =============
1781
1782 .. autodoxyclass:: simgrid::s4u::Comm
1783
1784 Basic management
1785 ----------------
1786
1787 .. tabs::
1788
1789    .. group-tab:: C++
1790
1791       .. code-block:: C++
1792
1793          #include <simgrid/s4u/Comm.hpp>
1794
1795       .. doxygentypedef:: CommPtr
1796
1797    .. group-tab:: Python
1798
1799       .. code:: Python
1800
1801          from simgrid import Comm
1802
1803 Querying info
1804 -------------
1805
1806 .. tabs::
1807
1808    .. group-tab:: C++
1809
1810       .. autodoxymethod:: simgrid::s4u::Comm::get_dst_data_size() const
1811       .. autodoxymethod:: simgrid::s4u::Comm::get_mailbox() const
1812       .. autodoxymethod:: simgrid::s4u::Comm::get_sender() const
1813       .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff)
1814       .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
1815       .. autodoxymethod:: simgrid::s4u::Comm::detach()
1816       .. autodoxymethod:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
1817       .. autodoxymethod:: simgrid::s4u::Comm::set_rate(double rate)
1818       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff)
1819       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
1820       .. autodoxymethod:: simgrid::s4u::Comm::set_src_data_size(size_t size)
1821
1822 Life cycle
1823 ----------
1824
1825 .. tabs::
1826
1827    .. group-tab:: C++
1828
1829       .. autodoxymethod:: simgrid::s4u::Comm::cancel
1830       .. autodoxymethod:: simgrid::s4u::Comm::start
1831       .. autodoxymethod:: simgrid::s4u::Comm::test
1832       .. autodoxymethod:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr > *comms)
1833       .. autodoxymethod:: simgrid::s4u::Comm::wait
1834       .. autodoxymethod:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr > *comms)
1835       .. autodoxymethod:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr > *comms)
1836       .. autodoxymethod:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr > *comms_in, double timeout)
1837       .. autodoxymethod:: simgrid::s4u::Comm::wait_for
1838
1839    .. group-tab:: Python
1840
1841        .. automethod:: simgrid.Comm.test
1842        .. automethod:: simgrid.Comm.wait
1843        .. automethod:: simgrid.Comm.wait_all
1844        .. automethod:: simgrid.Comm.wait_any
1845
1846 Signals
1847 -------
1848
1849 .. tabs::
1850
1851    .. group-tab:: C++
1852
1853       .. autodoxyvar:: simgrid::s4u::Comm::on_completion
1854       .. autodoxyvar:: simgrid::s4u::Comm::on_start
1855
1856 .. _API_s4u_Exec:
1857
1858 =============
1859 ⁣  class Exec
1860 =============
1861
1862 .. autodoxyclass:: simgrid::s4u::Exec
1863
1864 Basic management
1865 ----------------
1866
1867 .. tabs::
1868
1869    .. group-tab:: C++
1870
1871       .. code-block:: C++
1872
1873          #include <simgrid/s4u/Exec.hpp>
1874
1875       .. doxygentypedef:: ExecPtr
1876
1877    .. group-tab:: Python
1878
1879       .. code:: Python
1880
1881          from simgrid import Exec
1882
1883 Querying info
1884 -------------
1885
1886 .. tabs::
1887
1888    .. group-tab:: C++
1889
1890       .. autodoxymethod:: simgrid::s4u::Exec::get_cost() const
1891       .. autodoxymethod:: simgrid::s4u::Exec::get_finish_time() const
1892       .. autodoxymethod:: simgrid::s4u::Exec::get_host() const
1893       .. autodoxymethod:: simgrid::s4u::Exec::get_host_number() const
1894       .. cpp:function:: double Exec::get_remaining()
1895
1896          On sequential executions, returns the amount of flops that remain to be done;
1897          This cannot be used on parallel executions.
1898
1899       .. autodoxymethod:: simgrid::s4u::Exec::get_remaining_ratio
1900       .. autodoxymethod:: simgrid::s4u::Exec::get_start_time() const
1901       .. autodoxymethod:: simgrid::s4u::Exec::set_bound(double bound)
1902       .. autodoxymethod:: simgrid::s4u::Exec::set_host
1903       .. autodoxymethod:: simgrid::s4u::Exec::set_priority(double priority)
1904
1905    .. group-tab:: Python
1906
1907        .. autoattribute:: simgrid.Exec.host
1908        .. autoattribute:: simgrid.Exec.remaining
1909        .. autoattribute:: simgrid.Exec.remaining_ratio
1910
1911 Life cycle
1912 ----------
1913
1914 .. tabs::
1915
1916    .. group-tab:: C++
1917
1918       .. autodoxymethod:: simgrid::s4u::Exec::cancel
1919       .. autodoxymethod:: simgrid::s4u::Exec::set_timeout(double timeout)
1920       .. autodoxymethod:: simgrid::s4u::Exec::start
1921       .. autodoxymethod:: simgrid::s4u::Exec::test
1922       .. autodoxymethod:: simgrid::s4u::Exec::wait
1923       .. autodoxymethod:: simgrid::s4u::Exec::wait_any(std::vector< ExecPtr > *execs)
1924       .. autodoxymethod:: simgrid::s4u::Exec::wait_any_for(std::vector< ExecPtr > *execs, double timeout)
1925       .. autodoxymethod:: simgrid::s4u::Exec::wait_for
1926
1927    .. group-tab:: Python
1928
1929        .. automethod:: simgrid.Exec.cancel
1930        .. automethod:: simgrid.Exec.start
1931        .. automethod:: simgrid.Exec.test
1932        .. automethod:: simgrid.Exec.wait
1933
1934 Signals
1935 -------
1936
1937 .. tabs::
1938
1939    .. group-tab:: C++
1940
1941       .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion
1942       .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_start
1943
1944 .. _API_s4u_Io:
1945
1946 ===========
1947 ⁣  class Io
1948 ===========
1949
1950 .. autodoxyclass:: simgrid::s4u::Io
1951
1952 Basic management
1953 ----------------
1954
1955 .. tabs::
1956
1957    .. group-tab:: C++
1958
1959       .. code-block:: C++
1960
1961          #include <simgrid/s4u/Io.hpp>
1962
1963       .. doxygentypedef:: IoPtr
1964
1965 Querying info
1966 -------------
1967
1968 .. tabs::
1969
1970    .. group-tab:: C++
1971
1972       .. autodoxymethod:: simgrid::s4u::Io::get_performed_ioops() const
1973       .. autodoxymethod:: simgrid::s4u::Io::get_remaining
1974
1975 Life cycle
1976 ----------
1977
1978 .. tabs::
1979
1980    .. group-tab:: C++
1981
1982       .. autodoxymethod:: simgrid::s4u::Io::cancel
1983       .. autodoxymethod:: simgrid::s4u::Io::start
1984       .. autodoxymethod:: simgrid::s4u::Io::test
1985       .. autodoxymethod:: simgrid::s4u::Io::wait
1986       .. autodoxymethod:: simgrid::s4u::Io::wait_for
1987
1988 .. _API_s4u_Synchronizations:
1989
1990 =======================
1991 Synchronization Objects
1992 =======================
1993
1994 .. _API_s4u_Mutex:
1995
1996 ==============
1997 ⁣  Mutex
1998 ==============
1999
2000 .. autodoxyclass:: simgrid::s4u::Mutex
2001
2002 Basic management
2003 ----------------
2004
2005    .. tabs::
2006
2007       .. group-tab:: C++
2008
2009          .. code-block:: C++
2010
2011             #include <simgrid/s4u/Mutex.hpp>
2012
2013          .. doxygentypedef:: MutexPtr
2014
2015          .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
2016          .. autodoxymethod:: simgrid::s4u::Mutex::create()
2017          .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
2018
2019       .. group-tab:: C
2020
2021          .. code-block:: C
2022
2023             #include <simgrid/mutex.h>
2024
2025          .. doxygentypedef:: sg_mutex_t
2026          .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2027
2028             Pointer to a constant mutex object.
2029
2030          .. autodoxymethod:: sg_mutex_init()
2031          .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
2032
2033 Locking
2034 -------
2035
2036    .. tabs::
2037
2038       .. group-tab:: C++
2039
2040          .. autodoxymethod:: simgrid::s4u::Mutex::lock()
2041          .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
2042          .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
2043
2044       .. group-tab:: C
2045
2046          .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
2047          .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
2048          .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
2049
2050 .. _API_s4u_Barrier:
2051
2052 ================
2053 ⁣  Barrier
2054 ================
2055
2056 .. autodoxyclass:: simgrid::s4u::Barrier
2057
2058    .. tabs::
2059
2060       .. group-tab:: C++
2061
2062          .. code-block:: C++
2063
2064             #include <simgrid/s4u/Barrier.hpp>
2065
2066          .. doxygentypedef:: BarrierPtr
2067
2068          .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2069          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2070          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
2071
2072       .. group-tab:: C
2073
2074          .. code-block:: C
2075
2076             #include <simgrid/barrier.hpp>
2077
2078          .. doxygentypedef:: sg_bar_t
2079          .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2080
2081             Pointer to a constant barrier object.
2082
2083          .. autodoxymethod:: sg_barrier_init(unsigned int count)
2084          .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
2085          .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
2086
2087
2088 .. _API_s4u_ConditionVariable:
2089
2090 ==========================
2091 ⁣  Condition variable
2092 ==========================
2093
2094 .. autodoxyclass:: simgrid::s4u::ConditionVariable
2095
2096 Basic management
2097 ----------------
2098
2099    .. tabs::
2100
2101       .. group-tab:: C++
2102
2103          .. code-block:: C++
2104
2105             #include <simgrid/s4u/ConditionVariable.hpp>
2106
2107          .. doxygentypedef:: ConditionVariablePtr
2108
2109          .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
2110
2111       .. group-tab:: C
2112
2113          .. code-block:: C
2114
2115             #include <simgrid/cond.h>
2116
2117          .. doxygentypedef:: sg_cond_t
2118          .. autodoxymethod:: sg_cond_init
2119          .. autodoxymethod:: sg_cond_destroy
2120
2121 Waiting and notifying
2122 ---------------------
2123
2124    .. tabs::
2125
2126       .. group-tab:: C++
2127
2128          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
2129          .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
2130          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2131          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2132          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2133          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2134          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2135          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2136          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2137          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2138          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2139          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2140          .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2141
2142       .. group-tab:: C
2143
2144          .. autodoxymethod:: sg_cond_notify_all
2145          .. autodoxymethod:: sg_cond_notify_one
2146          .. autodoxymethod:: sg_cond_wait
2147          .. autodoxymethod:: sg_cond_wait_for
2148
2149 .. _API_s4u_Semaphore:
2150
2151 ==================
2152 ⁣  Semaphore
2153 ==================
2154
2155 .. autodoxyclass:: simgrid::s4u::Semaphore
2156
2157
2158 Basic management
2159 ----------------
2160
2161    .. tabs::
2162
2163       .. group-tab:: C++
2164
2165          .. code-block:: C++
2166
2167             #include <simgrid/s4u/Semaphore.hpp>
2168
2169          .. doxygentypedef:: SemaphorePtr
2170          .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
2171          .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
2172          .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2173
2174       .. group-tab:: C
2175
2176          .. code-block:: C
2177
2178             #include <simgrid/semaphore.h>
2179
2180          .. doxygentypedef:: sg_sem_t
2181          .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2182
2183             Pointer to a constant semaphore object.
2184
2185          .. autodoxymethod:: sg_sem_init(int initial_value)
2186          .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
2187
2188 Locking
2189 -------
2190
2191    .. tabs::
2192
2193       .. group-tab:: C++
2194
2195          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
2196          .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2197          .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity() const
2198          .. autodoxymethod:: simgrid::s4u::Semaphore::release()
2199          .. autodoxymethod:: simgrid::s4u::Semaphore::would_block() const
2200
2201       .. group-tab:: C
2202
2203          .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
2204          .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2205          .. autodoxymethod:: sg_sem_get_capacity(const_sg_sem_t sem)
2206          .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
2207          .. autodoxymethod:: sg_sem_would_block(const_sg_sem_t sem)
2208
2209 .. |hr| raw:: html
2210
2211    <hr />