8 <object id="TOC" data="graphical-toc.svg" type="image/svg+xml"></object>
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";
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
23 Since v3.20 (June 2018), S4U is the way to go for long-term
24 projects. It is feature complete, but may still evolve slightly in
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
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.
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.
47 When **communicating**, data is not directly sent to other actors but
48 posted onto a |API_s4u_Mailbox|_ that serves as a rendezvous 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|_.
56 Each actor is located on a simulated |API_s4u_Host|_. Each host is located
57 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.
64 The :ref:`simgrid::s4u::this_actor <API_s4u_this_actor>` namespace
65 provides many helper functions to simplify the code of actors.
67 - **Simulation Elements**
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 rendezvous, with which actors meet each other.
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.
89 - **Activities** (:ref:`class Activity <API_s4u_Activity>`):
90 The things that actors can do on resources
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 consuming disks.
99 - **Synchronization Objects**: Classical IPC that actors can use
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>`
107 .. |API_s4u_Actors| replace:: **Actors**
108 .. _API_s4u_Actors: #api-s4u-actor
110 .. |API_s4u_Activities| replace:: **Activities**
111 .. _API_s4u_Activities: #api-s4u-activity
113 .. |API_s4u_Hosts| replace:: **Hosts**
114 .. _API_s4u_Hosts: #api-s4u-host
116 .. |API_s4u_Links| replace:: **Links**
117 .. _API_s4u_Links: #api-s4u-link
119 .. |API_s4u_Disks| replace:: **Disks**
120 .. _API_s4u_Disks: #api-s4u-disk
122 .. |API_s4u_VirtualMachine| replace:: **VirtualMachines**
124 .. |API_s4u_Host| replace:: **Host**
126 .. |API_s4u_Mailbox| replace:: **Mailbox**
128 .. |API_s4u_Mailboxes| replace:: **Mailboxes**
129 .. _API_s4u_Mailboxes: #s4u-mailbox
131 .. |API_s4u_NetZone| replace:: **NetZone**
133 .. |API_s4u_Barrier| replace:: **Barrier**
135 .. |API_s4u_Semaphore| replace:: **Semaphore**
137 .. |API_s4u_ConditionVariable| replace:: **ConditionVariable**
139 .. |API_s4u_Mutex| replace:: **Mutex**
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.
152 =======================
153 Asynchronous Activities
154 =======================
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.
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 is 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>`.
172 Every kind of activity can be asynchronous:
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.
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
190 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
192 :start-after: init-begin
193 :end-before: init-end
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
200 :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
202 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
204 :start-after: put-begin
209 =====================
210 Activities Life cycle
211 =====================
213 Sometimes, you want to change the setting of an activity before it even starts.
215 .. todo:: write this section
222 Please also refer to the :ref:`API reference for s4u::Mailbox
229 |API_s4u_Mailboxes|_ are rendezvous 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.
234 They are similar to many common things: The phone number, which allows
235 the caller to find the receiver. The Twitter hashtag, which helps
236 senders and receivers to find each other. 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.
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).
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>`.
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.
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 mailboxes you are subscribed to.
267 The mailboxes are not located on the network, and you can access
268 them without any latency. The network delays 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.
274 =====================
275 How to use Mailboxes?
276 =====================
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 tool that can be used to build many different
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 out to be easy to build with the mailboxes.
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.
298 =========================================
299 How are put() and get() requests matched?
300 =========================================
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.
308 .. _s4u_receiving_actor:
310 ===========================
311 Declaring a Receiving Actor
312 ===========================
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.
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()>`
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 are 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.
337 ===============================
338 Communicating without Mailboxes
339 ===============================
341 Sometimes you don't want to simulate communications between actors as
342 allowed by mailboxes, but you want to create a direct communication
343 between two arbitrary hosts. This can arise when you write a
344 high-level model of a centralized scheduler, or when you model direct
345 communications such as one-sided communications in MPI or remote
346 memory direct access in PGAS.
348 For that, :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`
349 simulates a direct communication between the two specified hosts. No
350 mailbox is used, and there is no rendezvous between actors. You can
351 freely mix such direct communications and rendezvous-based
352 communications. Alternatively, :cpp:func:`Comm::sendto_init()
353 <simgrid::s4u::Comm::sendto_init()>` and
354 :cpp:func:`Comm::sendto_async() <simgrid::s4u::Comm::sendto_async()>`
355 create asynchronous direct communications.
362 For sake of simplicity, we use `RAII
363 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
364 for many classes in S4U. This is an idiom where resources are automatically
365 managed through the context. Provided that you never manipulate
366 objects of type Foo directly but always FooPtr references (which are
367 defined as `boost::intrusive_ptr
368 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
369 <Foo>), you will never have to explicitly release the resource that
370 you use nor to free the memory of unused objects.
371 Here is a little example:
377 simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
379 mutex->lock(); // use the mutex as a simple reference
383 } // The mutex gets automatically freed because the only existing reference gets out of scope
385 Note that Mailboxes, Hosts, and Links are not handled through smart
386 pointers (yet?). This means that it is currently impossible to destroy a
387 mailbox or a link. You can still destroy a host (but probably
388 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
392 .. include:: ../../examples/README.rst
397 .. _API_s4u_simulation_object:
409 .. doxygenclass:: simgrid::s4u::Actor
411 .. doxygentypedef:: aid_t
422 #include <simgrid/s4u/Actor.hpp>
424 .. doxygentypedef:: ActorPtr
426 .. group-tab:: Python
430 from simgrid import Actor
432 .. autoclass:: simgrid.Actor
438 #include <simgrid/actor.h>
440 .. doxygentypedef:: sg_actor_t
441 .. cpp:type:: const s4u_Actor* const_sg_actor_t
443 Pointer to a constant actor object.
445 .. doxygenfunction:: sg_actor_ref
446 .. doxygenfunction:: sg_actor_unref
456 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
457 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
458 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
459 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
461 .. doxygenfunction:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
462 .. doxygenfunction:: simgrid::s4u::Actor::start(const std::function< void()> &code)
463 .. doxygenfunction:: simgrid::s4u::Actor::set_stacksize
465 .. group-tab:: Python
467 .. automethod:: simgrid.Actor.create
471 .. doxygenfunction:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, char *const *argv)
472 .. doxygenfunction:: sg_actor_init(const char *name, sg_host_t host)
473 .. doxygenfunction:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char *const *argv)
474 .. doxygenfunction:: sg_actor_set_stacksize
476 .. doxygenfunction:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
477 .. doxygenfunction:: sg_actor_detach()
486 .. doxygenfunction:: simgrid::s4u::Actor::by_pid(aid_t pid)
487 .. doxygenfunction:: simgrid::s4u::Actor::self()
489 .. group-tab:: Python
491 .. automethod:: simgrid.Actor.by_pid
492 .. automethod:: simgrid.Actor.self
496 .. doxygenfunction:: sg_actor_by_pid(aid_t pid)
497 .. doxygenfunction:: sg_actor_self()
506 .. doxygenfunction:: simgrid::s4u::Actor::get_cname
507 .. doxygenfunction:: simgrid::s4u::Actor::get_name
508 .. doxygenfunction:: simgrid::s4u::Actor::get_pid
509 .. doxygenfunction:: simgrid::s4u::Actor::get_ppid
510 .. doxygenfunction:: simgrid::s4u::Actor::get_properties() const
511 .. doxygenfunction:: simgrid::s4u::Actor::get_property(const std::string &key) const
512 .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
514 .. doxygenfunction:: simgrid::s4u::Actor::get_host
515 .. doxygenfunction:: simgrid::s4u::Actor::set_host
517 .. doxygenfunction:: simgrid::s4u::Actor::get_refcount
518 .. doxygenfunction:: simgrid::s4u::Actor::get_impl
520 .. group-tab:: Python
522 .. autoattribute:: simgrid.Actor.name
523 .. autoattribute:: simgrid.Actor.host
524 .. autoattribute:: simgrid.Actor.pid
525 .. autoattribute:: simgrid.Actor.ppid
529 .. doxygenfunction:: sg_actor_get_name(const_sg_actor_t actor)
530 .. doxygenfunction:: sg_actor_get_pid(const_sg_actor_t actor)
531 .. doxygenfunction:: sg_actor_get_ppid(const_sg_actor_t actor)
532 .. doxygenfunction:: sg_actor_get_properties(const_sg_actor_t actor)
533 .. doxygenfunction:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
535 .. doxygenfunction:: sg_actor_get_host(const_sg_actor_t actor)
536 .. doxygenfunction:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
538 .. doxygenfunction:: sg_actor_get_data(const_sg_actor_t actor)
539 .. doxygenfunction:: sg_actor_set_data(sg_actor_t actor, void *userdata)
541 Suspending and resuming actors
542 ------------------------------
548 .. doxygenfunction:: simgrid::s4u::Actor::suspend()
549 .. doxygenfunction:: simgrid::s4u::Actor::resume()
550 .. doxygenfunction:: simgrid::s4u::Actor::is_suspended
552 .. group-tab:: Python
554 .. automethod:: simgrid.Actor.resume
555 .. automethod:: simgrid.Actor.suspend
556 .. automethod:: simgrid.Actor.is_suspended
560 .. doxygenfunction:: sg_actor_suspend(sg_actor_t actor)
561 .. doxygenfunction:: sg_actor_resume(sg_actor_t actor)
562 .. doxygenfunction:: sg_actor_is_suspended(const_sg_actor_t actor)
564 Specifying when actors should terminate
565 ---------------------------------------
571 .. doxygenfunction:: simgrid::s4u::Actor::kill()
572 .. doxygenfunction:: simgrid::s4u::Actor::kill_all()
573 .. doxygenfunction:: simgrid::s4u::Actor::set_kill_time(double time)
574 .. doxygenfunction:: simgrid::s4u::Actor::get_kill_time
576 .. doxygenfunction:: simgrid::s4u::Actor::restart()
577 .. doxygenfunction:: simgrid::s4u::Actor::daemonize()
578 .. doxygenfunction:: simgrid::s4u::Actor::is_daemon
580 .. group-tab:: Python
582 .. automethod:: simgrid.Actor.kill
583 .. automethod:: simgrid.Actor.kill_all
585 .. automethod:: simgrid.Actor.daemonize
586 .. automethod:: simgrid.Actor.is_daemon
590 .. doxygenfunction:: sg_actor_kill(sg_actor_t actor)
591 .. doxygenfunction:: sg_actor_kill_all()
592 .. doxygenfunction:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
594 .. doxygenfunction:: sg_actor_restart(sg_actor_t actor)
595 .. doxygenfunction:: sg_actor_daemonize(sg_actor_t actor)
596 .. doxygenfunction:: sg_actor_is_daemon
598 .. _API_s4u_Actor_end:
600 Reacting to the end of actors
601 -----------------------------
607 .. doxygenfunction:: simgrid::s4u::Actor::on_exit
608 .. doxygenfunction:: simgrid::s4u::Actor::join() const
609 .. doxygenfunction:: simgrid::s4u::Actor::join(double timeout) const
610 .. doxygenfunction:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
612 .. group-tab:: Python
614 .. automethod:: simgrid.Actor.join
618 .. doxygenfunction:: sg_actor_on_exit
619 .. doxygenfunction:: sg_actor_join(const_sg_actor_t actor, double timeout)
620 .. doxygenfunction:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
629 .. doxygenvariable:: simgrid::s4u::Actor::on_creation
630 .. doxygenvariable:: simgrid::s4u::Actor::on_suspend
631 .. doxygenvariable:: simgrid::s4u::Actor::on_host_change
632 .. doxygenvariable:: simgrid::s4u::Actor::on_resume
633 .. doxygenvariable:: simgrid::s4u::Actor::on_sleep
634 .. doxygenvariable:: simgrid::s4u::Actor::on_wake_up
635 .. doxygenvariable:: simgrid::s4u::Actor::on_termination
636 .. doxygenvariable:: simgrid::s4u::Actor::on_destruction
638 .. _API_s4u_this_actor:
644 These functions can be used in your user code to interact with the actor
645 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
646 Using these functions can greatly improve the code readability.
655 .. doxygenfunction:: simgrid::s4u::this_actor::get_cname()
656 .. doxygenfunction:: simgrid::s4u::this_actor::get_name()
657 .. doxygenfunction:: simgrid::s4u::this_actor::get_pid()
658 .. doxygenfunction:: simgrid::s4u::this_actor::get_ppid()
659 .. doxygenfunction:: simgrid::s4u::this_actor::is_maestro()
661 .. doxygenfunction:: simgrid::s4u::this_actor::get_host()
662 .. doxygenfunction:: simgrid::s4u::this_actor::set_host(Host *new_host)
664 .. group-tab:: Python
666 .. autofunction:: simgrid.this_actor.get_host
667 .. autofunction:: simgrid.this_actor.set_host
671 .. doxygenfunction:: sg_actor_self_get_data()
672 .. doxygenfunction:: sg_actor_self_set_data(void *data)
673 .. doxygenfunction:: sg_actor_self_get_name()
674 .. doxygenfunction:: sg_actor_self_get_pid()
675 .. doxygenfunction:: sg_actor_self_get_ppid()
676 .. doxygenfunction:: sg_host_self()
677 .. doxygenfunction:: sg_host_self_get_name()
679 Suspending and resuming
680 -----------------------
686 .. doxygenfunction:: simgrid::s4u::this_actor::suspend()
687 .. doxygenfunction:: simgrid::s4u::this_actor::yield()
689 .. group-tab:: Python
691 .. autofunction:: simgrid.this_actor.suspend
692 .. autofunction:: simgrid.this_actor.yield_
696 .. doxygenfunction:: sg_actor_yield()
703 .. group-tab:: Python
705 .. autofunction:: simgrid.this_actor.info
706 .. autofunction:: simgrid.this_actor.error
715 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(double duration)
716 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
717 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
718 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
720 .. group-tab:: Python
722 .. autofunction:: simgrid.this_actor.sleep_for
723 .. autofunction:: simgrid.this_actor.sleep_until
727 .. doxygenfunction:: sg_actor_sleep_for(double duration)
729 Simulating executions
730 ---------------------
732 Simulate the execution of some code on this actor. You can either simulate
733 parallel or sequential code and you can either block upon the termination of
734 the execution, or start an asynchronous activity.
740 .. doxygenfunction:: simgrid::s4u::this_actor::exec_async
741 .. doxygenfunction:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
742 .. doxygenfunction:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
743 .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop)
744 .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop, double priority)
745 .. doxygenfunction:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
746 .. doxygenfunction:: 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)
748 .. group-tab:: Python
750 .. autofunction:: simgrid.this_actor.exec_init
751 .. autofunction:: simgrid.this_actor.execute
755 .. doxygenfunction:: sg_actor_execute(double flops)
756 .. doxygenfunction:: sg_actor_execute_with_priority(double flops, double priority)
757 .. doxygenfunction:: sg_actor_exec_init(double computation_amount)
758 .. doxygenfunction:: sg_actor_exec_async(double computation_amount)
759 .. doxygenfunction:: sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount, double* bytes_amount);
768 .. doxygenfunction:: simgrid::s4u::this_actor::exit()
769 .. doxygenfunction:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
771 .. group-tab:: Python
773 .. autofunction:: simgrid.this_actor.exit
774 .. autofunction:: simgrid.this_actor.on_exit
778 See also :cpp:func:`sg_actor_on_exit`.
780 .. doxygenfunction:: sg_actor_exit
788 .. doxygenclass:: simgrid::s4u::Engine
797 .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
798 .. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
799 .. doxygenfunction:: simgrid::s4u::Engine::shutdown()
800 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
801 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
802 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
803 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
804 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
806 .. doxygenfunction:: simgrid::s4u::Engine::load_deployment
807 .. doxygenfunction:: simgrid::s4u::Engine::load_platform
808 .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name)
809 .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
810 .. doxygenfunction:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
811 .. doxygenfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
813 .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
814 .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
815 .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
817 .. group-tab:: Python
819 .. automethod:: simgrid.Engine.load_deployment
820 .. automethod:: simgrid.Engine.load_platform
821 .. automethod:: simgrid.Engine.register_actor
825 .. doxygenfunction:: simgrid_init
827 .. doxygenfunction:: simgrid_load_deployment
828 .. doxygenfunction:: simgrid_load_platform
829 .. doxygenfunction:: simgrid_register_default
830 .. doxygenfunction:: simgrid_register_function
839 .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
840 .. doxygenfunction:: simgrid::s4u::Engine::run
842 .. group-tab:: Python
844 .. automethod:: simgrid.Engine.get_clock
845 .. automethod:: simgrid.Engine.run
849 .. doxygenfunction:: simgrid_get_clock
850 .. doxygenfunction:: simgrid_run
859 .. doxygenfunction:: simgrid::s4u::Engine::get_actor_count
860 .. doxygenfunction:: simgrid::s4u::Engine::get_all_actors
861 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_actors
865 .. doxygenfunction:: simgrid_get_actor_count()
874 .. doxygenfunction:: simgrid::s4u::Engine::get_all_hosts
875 .. doxygenfunction:: simgrid::s4u::Engine::get_host_count
876 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_hosts
877 .. doxygenfunction:: simgrid::s4u::Engine::host_by_name
878 .. doxygenfunction:: simgrid::s4u::Engine::host_by_name_or_null
880 .. group-tab:: Python
882 .. automethod:: simgrid.Engine.get_all_hosts
886 See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
895 .. doxygenfunction:: simgrid::s4u::Engine::get_all_links
896 .. doxygenfunction:: simgrid::s4u::Engine::get_link_count
897 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_links
898 .. doxygenfunction:: simgrid::s4u::Engine::link_by_name
899 .. doxygenfunction:: simgrid::s4u::Engine::link_by_name_or_null
901 Interacting with the routing
902 ----------------------------
908 .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
909 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
910 .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
911 .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
912 .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
913 .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
914 .. doxygenfunction:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
923 .. doxygenvariable:: simgrid::s4u::Engine::on_deadlock
924 .. doxygenvariable:: simgrid::s4u::Engine::on_platform_created
925 .. doxygenvariable:: simgrid::s4u::Engine::on_platform_creation
926 .. doxygenvariable:: simgrid::s4u::Engine::on_simulation_end
927 .. doxygenvariable:: simgrid::s4u::Engine::on_time_advance
935 .. doxygenclass:: simgrid::s4u::Mailbox
937 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
948 #include <simgrid/s4u/Mailbox.hpp>
950 Note that there is no MailboxPtr type and that you cannot use the RAII
951 idiom on mailboxes because they are internal objects to the simulation
952 engine. Once created, there is no way to destroy a mailbox before the end
955 .. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
957 .. group-tab:: Python
961 #include <simgrid/mailbox.h>
963 .. autoclass:: simgrid.Mailbox
965 .. automethod:: simgrid.Mailbox.by_name
971 #include <simgrid/s4u/mailbox.h>
973 .. doxygentypedef:: sg_mailbox_t
974 .. doxygentypedef:: const_sg_mailbox_t
976 .. doxygenfunction:: sg_mailbox_by_name(const char *alias)
985 .. doxygenfunction:: simgrid::s4u::Mailbox::get_cname
986 .. doxygenfunction:: simgrid::s4u::Mailbox::get_name
988 .. group-tab:: Python
990 .. autoattribute:: simgrid.Mailbox.name
999 .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
1000 .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
1001 .. doxygenfunction:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
1002 .. doxygenfunction:: simgrid::s4u::Mailbox::put_init()
1003 .. doxygenfunction:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
1005 .. group-tab:: Python
1007 .. automethod:: simgrid.Mailbox.put
1008 .. automethod:: simgrid.Mailbox.put_async
1012 .. doxygenfunction:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1013 .. doxygenfunction:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1014 .. doxygenfunction:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1024 .. doxygenfunction:: simgrid::s4u::Mailbox::empty
1025 .. doxygenfunction:: simgrid::s4u::Mailbox::front
1026 .. doxygenfunction:: simgrid::s4u::Mailbox::get()
1027 .. doxygenfunction:: simgrid::s4u::Mailbox::get(double timeout)
1028 .. doxygenfunction:: simgrid::s4u::Mailbox::get_async(T **data)
1029 .. doxygenfunction:: simgrid::s4u::Mailbox::get_init()
1030 .. doxygenfunction:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
1031 .. doxygenfunction:: simgrid::s4u::Mailbox::listen
1032 .. doxygenfunction:: simgrid::s4u::Mailbox::ready
1034 .. group-tab:: Python
1036 .. automethod:: simgrid.Mailbox.get
1040 .. doxygenfunction:: sg_mailbox_get(sg_mailbox_t mailbox)
1041 .. doxygenfunction:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1042 .. doxygenfunction:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1043 .. doxygenfunction:: sg_mailbox_listen(const char *alias)
1048 See :ref:`s4u_receiving_actor`.
1054 .. doxygenfunction:: simgrid::s4u::Mailbox::get_receiver
1055 .. doxygenfunction:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1059 .. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
1061 .. _API_s4u_Resource:
1073 .. doxygenclass:: simgrid::s4u::Disk
1084 #include <simgrid/s4u/Disk.hpp>
1086 Note that there is no DiskPtr type and that you cannot use the RAII
1087 idiom on disks because SimGrid does not allow (yet) to create nor
1088 destroy resources once the simulation is started.
1098 .. doxygenfunction:: simgrid::s4u::Disk::get_cname() const
1099 .. doxygenfunction:: simgrid::s4u::Disk::get_host() const
1100 .. doxygenfunction:: simgrid::s4u::Disk::get_name() const
1101 .. doxygenfunction:: simgrid::s4u::Disk::get_properties() const
1102 .. doxygenfunction:: simgrid::s4u::Disk::get_property(const std::string &key) const
1103 .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
1104 .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
1105 .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1114 .. doxygenfunction:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type) const
1115 .. doxygenfunction:: simgrid::s4u::Disk::read(sg_size_t size) const
1116 .. doxygenfunction:: simgrid::s4u::Disk::read_async(sg_size_t size) const
1117 .. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
1118 .. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
1127 .. doxygenvariable:: simgrid::s4u::Disk::on_creation
1128 .. doxygenvariable:: simgrid::s4u::Disk::on_destruction
1129 .. doxygenvariable:: simgrid::s4u::Disk::on_state_change
1138 .. doxygenclass:: simgrid::s4u::Host
1149 #include <simgrid/s4u/Host.hpp>
1151 Note that there is no HostPtr type, and that you cannot use the RAII
1152 idiom on hosts because SimGrid does not allow (yet) to create nor
1153 destroy resources once the simulation is started.
1155 .. doxygenfunction:: simgrid::s4u::Host::destroy()
1157 .. group-tab:: Python
1161 from simgrid import Host
1167 #include <simgrid/host.h>
1169 .. doxygentypedef:: sg_host_t
1170 .. cpp:type:: const s4u_Host* const_sg_host_t
1172 Pointer to a constant host object.
1181 See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1183 .. doxygenfunction:: simgrid::s4u::Host::by_name(const std::string &name)
1184 .. doxygenfunction:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1185 .. doxygenfunction:: simgrid::s4u::Host::current()
1187 .. group-tab:: Python
1189 See also :py:func:`simgrid.Engine.get_all_hosts`.
1191 .. automethod:: simgrid.Host.by_name
1192 .. automethod:: simgrid.Host.current
1196 .. doxygenfunction:: sg_host_by_name(const char *name)
1197 .. doxygenfunction:: sg_host_count()
1198 .. doxygenfunction:: sg_host_list()
1199 .. doxygenfunction:: sg_hosts_as_dynar()
1208 .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1209 .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1210 .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1211 .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1212 .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1213 .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1215 .. group-tab:: Python
1217 .. autoattribute:: simgrid.Host.name
1218 .. autoattribute:: simgrid.Host.load
1219 .. autoattribute:: simgrid.Host.pstate
1220 .. autoattribute:: simgrid.Host.speed
1224 .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1225 .. doxygenfunction:: sg_host_dump(const_sg_host_t ws)
1226 .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1227 .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1228 .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1230 User data and properties
1231 ------------------------
1237 .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1238 .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1239 .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1240 .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1244 .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1245 .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1246 .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1247 .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1248 .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1250 Retrieving components
1251 ---------------------
1257 .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1258 .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1259 .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1260 .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1261 .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1265 .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1274 .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1275 .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1276 .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1280 .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1281 .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1282 .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1291 .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1292 .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1293 .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
1294 .. doxygenfunction:: simgrid::s4u::Host::set_pstate(int pstate_index)
1295 .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1296 .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1298 .. group-tab:: Python
1300 .. automethod:: simgrid.Host.get_pstate_count
1301 .. automethod:: simgrid.Host.get_pstate_speed
1305 .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1306 .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1307 .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1308 .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1309 .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, int pstate)
1318 .. doxygenfunction:: simgrid::s4u::Host::exec_async
1319 .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1320 .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1322 Platform and routing
1323 --------------------
1325 You can also start direct communications between two arbitrary hosts
1326 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1332 .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1333 .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1334 .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1335 .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
1339 .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1340 .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1341 .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1342 .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1351 .. doxygenvariable:: simgrid::s4u::Host::on_creation
1352 .. doxygenvariable:: simgrid::s4u::Host::on_destruction
1353 .. doxygenvariable:: simgrid::s4u::Host::on_speed_change
1354 .. doxygenvariable:: simgrid::s4u::Host::on_state_change
1362 .. doxygenclass:: simgrid::s4u::Link
1363 .. doxygenclass:: simgrid::s4u::SplitDuplexLink
1364 .. doxygenclass:: simgrid::s4u::LinkInRoute
1375 #include <simgrid/s4u/Link.hpp>
1377 Note that there is no LinkPtr type and that you cannot use the RAII
1378 idiom on hosts because SimGrid does not allow (yet) to create nor
1379 destroy resources once the simulation is started.
1381 .. group-tab:: Python
1385 from simgrid import Link
1391 #include <simgrid/link.h>
1393 .. doxygentypedef:: sg_link_t
1394 .. cpp:type:: const s4u_Link* const_sg_link_t
1396 Pointer to a constant link object.
1405 See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1407 .. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
1408 .. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1412 .. doxygenfunction:: sg_link_by_name(const char *name)
1413 .. doxygenfunction:: sg_link_count()
1414 .. doxygenfunction:: sg_link_list()
1423 .. doxygenfunction:: simgrid::s4u::Link::get_bandwidth() const
1424 .. doxygenfunction:: simgrid::s4u::Link::get_cname() const
1425 .. doxygenfunction:: simgrid::s4u::Link::get_latency() const
1426 .. doxygenfunction:: simgrid::s4u::Link::get_name() const
1427 .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const
1428 .. doxygenfunction:: simgrid::s4u::Link::get_usage() const
1429 .. doxygenfunction:: simgrid::s4u::Link::is_used() const
1433 .. doxygenfunction:: sg_link_get_bandwidth(const_sg_link_t link)
1434 .. doxygenfunction:: sg_link_get_latency(const_sg_link_t link)
1435 .. doxygenfunction:: sg_link_get_name(const_sg_link_t link)
1436 .. doxygenfunction:: sg_link_is_shared(const_sg_link_t link)
1438 Modifying characteristics
1439 -------------------------
1445 .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
1446 .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
1450 .. doxygenfunction:: sg_link_set_bandwidth(sg_link_t link, double value)
1451 .. doxygenfunction:: sg_link_set_latency(sg_link_t link, double value)
1453 User data and properties
1454 ------------------------
1460 .. doxygenfunction:: simgrid::s4u::Link::get_property(const std::string &key) const
1461 .. doxygenfunction:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1465 .. doxygenfunction:: sg_link_get_data(const_sg_link_t link)
1466 .. doxygenfunction:: sg_link_set_data(sg_link_t link, void *data)
1475 See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1477 .. doxygenfunction:: simgrid::s4u::Link::is_on() const
1478 .. doxygenfunction:: simgrid::s4u::Link::turn_off()
1479 .. doxygenfunction:: simgrid::s4u::Link::turn_on()
1484 See :ref:`howto_churn` for more details.
1490 .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1491 .. doxygenfunction:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1492 .. doxygenfunction:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1501 .. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
1510 .. doxygenvariable:: simgrid::s4u::Link::on_bandwidth_change
1511 .. doxygenvariable:: simgrid::s4u::Link::on_communicate
1512 .. doxygenvariable:: simgrid::s4u::Link::on_communication_state_change
1513 .. doxygenvariable:: simgrid::s4u::Link::on_creation
1514 .. doxygenvariable:: simgrid::s4u::Link::on_destruction
1515 .. doxygenvariable:: simgrid::s4u::Link::on_state_change
1517 .. _API_s4u_NetZone:
1523 .. doxygenclass:: simgrid::s4u::NetZone
1534 #include <simgrid/s4u/NetZone.hpp>
1536 Note that there is no NetZonePtr type and that you cannot use the RAII
1537 idiom on network zones because SimGrid does not allow (yet) to create nor
1538 destroy resources once the simulation is started.
1544 #include <simgrid/zone.h>
1546 .. doxygentypedef:: sg_netzone_t
1547 .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1549 Pointer to a constant network zone object.
1558 See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1559 :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1560 :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1564 .. doxygenfunction:: sg_zone_get_by_name(const char *name)
1565 .. doxygenfunction:: sg_zone_get_root()
1574 .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
1575 .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
1579 .. doxygenfunction:: sg_zone_get_name(const_sg_netzone_t zone)
1581 User data and properties
1582 ------------------------
1588 .. doxygenfunction:: simgrid::s4u::NetZone::get_properties() const
1589 .. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1590 .. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1594 .. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1595 .. doxygenfunction:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1597 Retrieving components
1598 ---------------------
1604 .. doxygenfunction:: simgrid::s4u::NetZone::get_all_hosts() const
1605 .. doxygenfunction:: simgrid::s4u::NetZone::get_host_count() const
1609 .. doxygenfunction:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1618 .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1619 .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1620 .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
1621 .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1622 .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
1626 .. doxygenfunction:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1635 .. doxygenvariable:: simgrid::s4u::NetZone::on_creation
1636 .. doxygenvariable:: simgrid::s4u::NetZone::on_seal
1638 .. _API_s4u_VirtualMachine:
1640 =======================
1641 class VirtualMachine
1642 =======================
1645 .. doxygenclass:: simgrid::s4u::VirtualMachine
1655 #include <simgrid/s4u/VirtualMachine.hpp>
1657 Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1658 idiom on virtual machines. There is no good reason for that and should change in the future.
1664 #include <simgrid/vm.h>
1666 .. doxygentypedef:: sg_vm_t
1667 .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1669 Pointer to a constant virtual machine object.
1678 .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1679 .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1680 .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1684 .. doxygenfunction:: sg_vm_create_core
1685 .. doxygenfunction:: sg_vm_create_multicore
1686 .. doxygenfunction:: sg_vm_destroy
1695 .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1696 .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
1697 .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
1699 .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1700 .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1701 .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1705 .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
1706 .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
1707 .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1709 .. doxygenfunction:: sg_vm_get_name
1710 .. doxygenfunction:: sg_vm_get_pm
1711 .. doxygenfunction:: sg_vm_is_created
1712 .. doxygenfunction:: sg_vm_is_running
1713 .. doxygenfunction:: sg_vm_is_suspended
1722 .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
1723 .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
1724 .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
1725 .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
1729 .. doxygenfunction:: sg_vm_start
1730 .. doxygenfunction:: sg_vm_suspend
1731 .. doxygenfunction:: sg_vm_resume
1732 .. doxygenfunction:: sg_vm_shutdown
1741 .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_end
1742 .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_start
1743 .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_resume
1744 .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_shutdown
1745 .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_start
1746 .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_started
1747 .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_suspend
1749 .. _API_s4u_Activity:
1755 .. doxygenclass:: simgrid::s4u::Activity
1757 **Known subclasses:**
1758 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1759 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1760 :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1761 See also the :ref:`section on activities <s4u_Activities>` above.
1772 #include <simgrid/s4u/Activity.hpp>
1774 .. doxygentypedef:: ActivityPtr
1783 .. doxygenfunction:: simgrid::s4u::Activity::get_cname
1784 .. doxygenfunction:: simgrid::s4u::Activity::get_name
1785 .. doxygenfunction:: simgrid::s4u::Activity::get_remaining() const
1786 .. doxygenfunction:: simgrid::s4u::Activity::get_state() const
1787 .. doxygenfunction:: simgrid::s4u::Activity::set_remaining(double remains)
1788 .. doxygenfunction:: simgrid::s4u::Activity::set_state(Activity::State state)
1791 Activities life cycle
1792 ---------------------
1798 .. doxygenfunction:: simgrid::s4u::Activity::start
1799 .. doxygenfunction:: simgrid::s4u::Activity::cancel
1800 .. doxygenfunction:: simgrid::s4u::Activity::test
1801 .. doxygenfunction:: simgrid::s4u::Activity::wait
1802 .. doxygenfunction:: simgrid::s4u::Activity::wait_for
1803 .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit)
1804 .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start()
1806 Suspending and resuming an activity
1807 -----------------------------------
1813 .. doxygenfunction:: simgrid::s4u::Activity::suspend
1814 .. doxygenfunction:: simgrid::s4u::Activity::resume
1815 .. doxygenfunction:: simgrid::s4u::Activity::is_suspended
1823 .. doxygenclass:: simgrid::s4u::Comm
1834 #include <simgrid/s4u/Comm.hpp>
1836 .. doxygentypedef:: CommPtr
1838 .. group-tab:: Python
1842 from simgrid import Comm
1844 .. autoclass:: simgrid.Comm
1850 #include <simgrid/comm.h>
1852 .. doxygentypedef:: sg_comm_t
1853 .. doxygentypedef:: const_sg_comm_t
1862 .. doxygenfunction:: simgrid::s4u::Comm::get_dst_data_size() const
1863 .. doxygenfunction:: simgrid::s4u::Comm::get_mailbox() const
1864 .. doxygenfunction:: simgrid::s4u::Comm::get_sender() const
1865 .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff)
1866 .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
1867 .. doxygenfunction:: simgrid::s4u::Comm::detach()
1868 .. doxygenfunction:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
1869 .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(double bytes)
1870 .. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
1871 .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
1872 .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
1873 .. doxygenfunction:: simgrid::s4u::Comm::set_src_data_size(size_t size)
1878 Most communications are created using :ref:`s4u_mailbox`, but you can
1879 also start direct communications as shown below.
1885 .. doxygenfunction:: simgrid::s4u::Comm::sendto
1886 .. doxygenfunction:: simgrid::s4u::Comm::sendto_init
1887 .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
1889 .. doxygenfunction:: simgrid::s4u::Comm::cancel
1890 .. doxygenfunction:: simgrid::s4u::Comm::start
1891 .. doxygenfunction:: simgrid::s4u::Comm::test
1892 .. doxygenfunction:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr >& comms)
1893 .. doxygenfunction:: simgrid::s4u::Comm::wait
1894 .. doxygenfunction:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr >& comms)
1895 .. doxygenfunction:: simgrid::s4u::Comm::wait_all_for(const std::vector< CommPtr >& comms, double timeout)
1896 .. doxygenfunction:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr >& comms)
1897 .. doxygenfunction:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr >& comms, double timeout)
1898 .. doxygenfunction:: simgrid::s4u::Comm::wait_for
1900 .. group-tab:: Python
1902 .. automethod:: simgrid.Comm.test
1903 .. automethod:: simgrid.Comm.wait
1904 .. automethod:: simgrid.Comm.wait_all
1905 .. automethod:: simgrid.Comm.wait_any
1909 .. doxygenfunction:: sg_comm_test
1910 .. doxygenfunction:: sg_comm_wait
1911 .. doxygenfunction:: sg_comm_wait_all
1912 .. doxygenfunction:: sg_comm_wait_any
1921 .. doxygenvariable:: simgrid::s4u::Comm::on_completion
1922 .. doxygenvariable:: simgrid::s4u::Comm::on_start
1930 .. doxygenclass:: simgrid::s4u::Exec
1941 #include <simgrid/s4u/Exec.hpp>
1943 .. doxygentypedef:: ExecPtr
1945 .. group-tab:: Python
1949 from simgrid import Exec
1951 .. autoclass:: simgrid.Exec
1957 #include <simgrid/exec.h>
1959 .. doxygentypedef:: sg_exec_t
1960 .. doxygentypedef:: const_sg_exec_t
1969 .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
1970 .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
1971 .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
1972 .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
1973 .. doxygenfunction:: simgrid::s4u::Exec::get_remaining
1974 .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
1975 .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
1976 .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
1977 .. doxygenfunction:: simgrid::s4u::Exec::set_host
1978 .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
1980 .. group-tab:: Python
1982 .. autoattribute:: simgrid.Exec.host
1983 .. autoattribute:: simgrid.Exec.remaining
1984 .. autoattribute:: simgrid.Exec.remaining_ratio
1988 .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
1989 .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
1990 .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
1991 .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
1992 .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
1993 .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
2002 .. doxygenfunction:: simgrid::s4u::Exec::cancel
2003 .. doxygenfunction:: simgrid::s4u::Exec::start
2004 .. doxygenfunction:: simgrid::s4u::Exec::test
2005 .. doxygenfunction:: simgrid::s4u::Exec::wait
2006 .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2007 .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2008 .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2010 .. group-tab:: Python
2012 .. automethod:: simgrid.Exec.cancel
2013 .. automethod:: simgrid.Exec.start
2014 .. automethod:: simgrid.Exec.test
2015 .. automethod:: simgrid.Exec.wait
2019 .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2020 .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2021 .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2022 .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2023 .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2024 .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2025 .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2034 .. doxygenvariable:: simgrid::s4u::Exec::on_start
2035 .. doxygenvariable:: simgrid::s4u::Exec::on_completion
2043 .. doxygenclass:: simgrid::s4u::Io
2054 #include <simgrid/s4u/Io.hpp>
2056 .. doxygentypedef:: IoPtr
2065 .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2066 .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2075 .. doxygenfunction:: simgrid::s4u::Io::cancel
2076 .. doxygenfunction:: simgrid::s4u::Io::start
2077 .. doxygenfunction:: simgrid::s4u::Io::test
2078 .. doxygenfunction:: simgrid::s4u::Io::wait
2079 .. doxygenfunction:: simgrid::s4u::Io::wait_for
2081 .. _API_s4u_Synchronizations:
2083 =======================
2084 Synchronization Objects
2085 =======================
2093 .. doxygenclass:: simgrid::s4u::Mutex
2104 #include <simgrid/s4u/Mutex.hpp>
2106 .. doxygentypedef:: MutexPtr
2108 .. doxygenfunction:: simgrid::s4u::Mutex::create()
2114 #include <simgrid/mutex.h>
2116 .. doxygentypedef:: sg_mutex_t
2117 .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2119 Pointer to a constant mutex object.
2121 .. doxygenfunction:: sg_mutex_init()
2122 .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2131 .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2132 .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2133 .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2137 .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2138 .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2139 .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2141 .. _API_s4u_Barrier:
2147 .. doxygenclass:: simgrid::s4u::Barrier
2155 #include <simgrid/s4u/Barrier.hpp>
2157 .. doxygentypedef:: BarrierPtr
2159 .. doxygenfunction:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2160 .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2161 .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2167 #include <simgrid/barrier.hpp>
2169 .. doxygentypedef:: sg_bar_t
2170 .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2172 Pointer to a constant barrier object.
2174 .. doxygenfunction:: sg_barrier_init(unsigned int count)
2175 .. doxygenfunction:: sg_barrier_destroy(const_sg_bar_t bar)
2176 .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2179 .. _API_s4u_ConditionVariable:
2181 ==========================
2182 Condition variable
2183 ==========================
2185 .. doxygenclass:: simgrid::s4u::ConditionVariable
2196 #include <simgrid/s4u/ConditionVariable.hpp>
2198 .. doxygentypedef:: ConditionVariablePtr
2200 .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2206 #include <simgrid/cond.h>
2208 .. doxygentypedef:: sg_cond_t
2209 .. doxygentypedef:: const_sg_cond_t
2210 .. doxygenfunction:: sg_cond_init
2211 .. doxygenfunction:: sg_cond_destroy
2213 Waiting and notifying
2214 ---------------------
2220 .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2221 .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2222 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2223 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2224 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2225 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2226 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2227 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2228 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2229 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2230 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2231 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2232 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2236 .. doxygenfunction:: sg_cond_notify_all
2237 .. doxygenfunction:: sg_cond_notify_one
2238 .. doxygenfunction:: sg_cond_wait
2239 .. doxygenfunction:: sg_cond_wait_for
2241 .. _API_s4u_Semaphore:
2247 .. doxygenclass:: simgrid::s4u::Semaphore
2259 #include <simgrid/s4u/Semaphore.hpp>
2261 .. doxygentypedef:: SemaphorePtr
2262 .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2268 #include <simgrid/semaphore.h>
2270 .. doxygentypedef:: sg_sem_t
2271 .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2273 Pointer to a constant semaphore object.
2275 .. doxygenfunction:: sg_sem_init(int initial_value)
2276 .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2285 .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2286 .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2287 .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2288 .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2289 .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2293 .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2294 .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2295 .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2296 .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2297 .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)