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 .. rst-class:: compact-list
69 - **Simulation Elements**
71 - :ref:`class Actor <API_s4u_Actor>`: Active entities executing your application.
72 - :ref:`class Engine <API_s4u_Engine>`: Simulation engine (singleton).
73 - :ref:`class Mailbox <API_s4u_Mailbox>`: Communication rendezvous, with which actors meet each other.
77 - :ref:`class Disk <API_s4u_Disk>`: Resource on which actors can write and read data.
78 - :ref:`class Host <API_s4u_Host>`: Actor location, providing computational power.
79 - :ref:`class Link <API_s4u_Link>`: Interconnecting hosts.
80 - :ref:`class NetZone <API_s4u_NetZone>`: Sub-region of the platform, containing resources (Hosts, Links, etc).
81 - :ref:`class VirtualMachine <API_s4u_VirtualMachine>`: Execution containers that can be moved between Hosts.
83 - **Activities** (:ref:`class Activity <API_s4u_Activity>`): The things that actors can do on resources.
85 - :ref:`class Comm <API_s4u_Comm>`: Communication activity, started on Mailboxes and consuming links.
86 - :ref:`class Exec <API_s4u_Exec>`: Computation activity, started on Host and consuming CPU resources.
87 - :ref:`class Io <API_s4u_Io>`: I/O activity, started on and consuming disks.
89 - **Synchronization Objects**: Classical IPC that actors can use
91 - :ref:`class Barrier <API_s4u_Barrier>`
92 - :ref:`class ConditionVariable <API_s4u_ConditionVariable>`
93 - :ref:`class Mutex <API_s4u_Mutex>`
94 - :ref:`class Semaphore <API_s4u_Semaphore>`
96 .. |API_s4u_Actors| replace:: **Actors**
97 .. _API_s4u_Actors: #api-s4u-actor
99 .. |API_s4u_Activities| replace:: **Activities**
100 .. _API_s4u_Activities: #api-s4u-activity
102 .. |API_s4u_Hosts| replace:: **Hosts**
103 .. _API_s4u_Hosts: #api-s4u-host
105 .. |API_s4u_Links| replace:: **Links**
106 .. _API_s4u_Links: #api-s4u-link
108 .. |API_s4u_Disks| replace:: **Disks**
109 .. _API_s4u_Disks: #api-s4u-disk
111 .. |API_s4u_VirtualMachine| replace:: **VirtualMachines**
113 .. |API_s4u_Host| replace:: **Host**
115 .. |API_s4u_Mailbox| replace:: **Mailbox**
117 .. |API_s4u_Mailboxes| replace:: **Mailboxes**
118 .. _API_s4u_Mailboxes: #s4u-mailbox
120 .. |API_s4u_NetZone| replace:: **NetZone**
122 .. |API_s4u_Barrier| replace:: **Barrier**
124 .. |API_s4u_Semaphore| replace:: **Semaphore**
126 .. |API_s4u_ConditionVariable| replace:: **ConditionVariable**
128 .. |API_s4u_Mutex| replace:: **Mutex**
135 Activities represent the actions that consume a resource, such as a
136 :ref:`Comm <API_s4u_Comm>` that consumes the *transmitting power* of
137 :ref:`Link <API_s4u_Link>` resources, or an :ref:`Exec <API_s4u_Exec>`
138 that consumes the *computing power* of :ref:`Host <API_s4u_Host>` resources.
139 See also the :ref:`full API <API_s4u_Activity>` below.
141 =======================
142 Asynchronous Activities
143 =======================
145 Every activity can be either **blocking** or **asynchronous**. For
146 example, :cpp:func:`s4u::Mailbox::put() <simgrid::s4u::Mailbox::put>`
147 and :cpp:func:`s4u::Mailbox::get() <simgrid::s4u::Mailbox::get>`
148 create blocking communications: the actor is blocked until the
149 completion of that communication. Asynchronous communications do not
150 block the actor during their execution but progress on their own.
152 Once your asynchronous activity is started, you can test for its
153 completion using :cpp:func:`s4u::Activity::test() <simgrid::s4u::Activity::test>`.
154 This function returns ``true`` if the activity is completed already.
155 You can also use :cpp:func:`s4u::Activity::wait() <simgrid::s4u::Activity::wait>`
156 to block until the completion of the activity. To wait for at most a given amount of time,
157 use :cpp:func:`s4u::Activity::wait_for() <simgrid::s4u::Activity::wait_for>`.
158 Finally, to wait at most until a specified time limit, use
159 :cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
161 Every kind of activity can be asynchronous.
162 :ref:`s4u::CommPtr <API_s4u_Comm>` are created with :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
163 :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`;
164 :ref:`s4u::IoPtr <API_s4u_Io>` are created with :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
165 :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`; and
166 :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
167 :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
168 In the future, it will become possible to have asynchronous IPC such as asynchronous mutex lock requests.
170 The following example shows how to have several concurrent
171 communications ongoing. First, you have to declare a vector in which
172 we will store the ongoing communications. It is also useful to have a
175 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
177 :start-after: init-begin
178 :end-before: init-end
181 Then, you start all the communications that should occur concurrently with
182 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
183 Finally, the actor waits for the completion of all of them at once
184 with :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
186 .. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
188 :start-after: put-begin
192 =====================
193 Activities Life cycle
194 =====================
196 Sometimes, you want to change the setting of an activity before it even starts.
198 .. todo:: write this section
205 Please also refer to the :ref:`API reference for s4u::Mailbox
212 |API_s4u_Mailboxes|_ are rendezvous points for network communications,
213 similar to URLs on which you could post and retrieve data. Actually,
214 the mailboxes are not involved in the communication once it starts,
215 but only to find the contact with which you want to communicate.
217 They are similar to many common things: The phone number, which allows
218 the caller to find the receiver. The Twitter hashtag, which helps
219 senders and receivers to find each other. In TCP, the pair
220 ``{host name, host port}`` to which you can connect to find your peer.
221 In HTTP, URLs through which the clients can connect to the servers.
222 In ZeroMQ, the queues are used to match senders and receivers.
224 One big difference with most of these systems is that no actor is the
225 exclusive owner of a mailbox, neither in sending nor in receiving.
226 Many actors can send into and/or receive from the same mailbox. TCP
227 socket ports for example are shared on the sender side but exclusive
228 on the receiver side (only one process can receive from a given socket
229 at a given point of time).
231 A big difference with TCP sockets or MPI communications is that
232 communications do not start right away after a
233 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put>`, but wait
234 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get>`.
235 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
237 A big difference with Twitter hashtags is that SimGrid does not
238 offer easy support to broadcast a given message to many
239 receivers. So that would be like a Twitter tag where each message
240 is consumed by the first receiver.
242 A big difference with the ZeroMQ queues is that you cannot filter
243 on the data you want to get from the mailbox. To model such settings
244 in SimGrid, you'd have one mailbox per potential topic, and subscribe
245 to each topic individually with a
246 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async>` on each mailbox.
247 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any>`
248 to get the first message on any of the mailboxes you are subscribed to.
250 The mailboxes are not located on the network, and you can access
251 them without any latency. The network delays are only related to the
252 location of the sender and receiver once the match between them is
253 done on the mailbox. This is just like the phone number that you
254 can use locally, and the geographical distance only comes into play
255 once you start the communication by dialing this number.
257 =====================
258 How to use Mailboxes?
259 =====================
261 You can retrieve any existing mailbox from its name (which is a
262 unique string, just like a Twitter tag). This results in a
263 versatile tool that can be used to build many different
266 To model classical socket communications, use "hostname:port" as
267 mailbox names, and make sure that only one actor reads into a given
268 mailbox. This does not make it easy to build a perfectly realistic
269 model of the TCP sockets, but in most cases, this system is too
270 cumbersome for your simulations anyway. You probably want something
271 simpler, that turns out to be easy to build with the mailboxes.
273 Many SimGrid examples use a sort of yellow page system where the
274 mailbox names are the name of the service (such as "worker",
275 "master", or "reducer"). That way, you don't have to know where your
276 peer is located to contact it. You don't even need its name. Its
277 function is enough for that. This also gives you some sort of load
278 balancing for free if more than one actor pulls from the mailbox:
279 the first actor that can deal with the request will handle it.
281 =========================================
282 How are put() and get() requests matched?
283 =========================================
285 The matching algorithm simple: first come, first serve. When a new
286 send arrives, it matches the oldest enqueued receive. If no receive is
287 currently enqueued, then the incoming send is enqueued. As you can
288 see, the mailbox cannot contain both send and receive requests: all
289 enqueued requests must be of the same sort.
291 .. _s4u_receiving_actor:
293 ===========================
294 Declaring a Receiving Actor
295 ===========================
297 The last twist is that by default in the simulator, the data starts
298 to be exchanged only when both the sender and the receiver are
299 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
300 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
301 In TCP, since you establish connections beforehand, the data starts to
302 flow as soon as the sender posts it, even if the receiver did not post
303 its :cpp:func:`put() <simgrid::s4u::Mailbox::put()>` yet.
305 To model this in SimGrid, you can declare a specific receiver to a
306 given mailbox (with the function
307 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
308 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
309 posted to that mailbox will start as soon as possible, and the data
310 will already be there on the receiver host when the receiver actor
311 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
313 Note that being permanent receivers of a mailbox prevents actors to be
314 garbage-collected. If your simulation creates many short-lived actors
315 that are marked as permanent receiver, you should call
316 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
317 memory gets properly reclaimed. This call should be at the end of the
318 actor's function, not in an on_exit callback.
320 ===============================
321 Communicating without Mailboxes
322 ===============================
324 Sometimes you don't want to simulate communications between actors as
325 allowed by mailboxes, but you want to create a direct communication
326 between two arbitrary hosts. This can arise when you write a
327 high-level model of a centralized scheduler, or when you model direct
328 communications such as one-sided communications in MPI or remote
329 memory direct access in PGAS.
331 For that, :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`
332 simulates a direct communication between the two specified hosts. No
333 mailbox is used, and there is no rendezvous between actors. You can
334 freely mix such direct communications and rendezvous-based
335 communications. Alternatively, :cpp:func:`Comm::sendto_init()
336 <simgrid::s4u::Comm::sendto_init()>` and
337 :cpp:func:`Comm::sendto_async() <simgrid::s4u::Comm::sendto_async()>`
338 create asynchronous direct communications.
345 For sake of simplicity, we use `RAII
346 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
347 for many classes in S4U. This is an idiom where resources are automatically
348 managed through the context. Provided that you never manipulate
349 objects of type Foo directly but always FooPtr references (which are
350 defined as `boost::intrusive_ptr
351 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
352 <Foo>), you will never have to explicitly release the resource that
353 you use nor to free the memory of unused objects.
354 Here is a little example:
360 simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
362 mutex->lock(); // use the mutex as a simple reference
366 } // The mutex gets automatically freed because the only existing reference gets out of scope
368 Note that Mailboxes, Hosts, and Links are not handled through smart
369 pointers (yet?). This means that it is currently impossible to destroy a
370 mailbox or a link. You can still destroy a host (but probably
371 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
375 .. include:: ../../examples/README.rst
380 .. _API_s4u_simulation_object:
396 .. doxygenclass:: simgrid::s4u::Actor
398 .. doxygentypedef:: aid_t
401 .. group-tab:: Python
403 .. autoclass:: simgrid.Actor
414 #include <simgrid/s4u/Actor.hpp>
416 .. doxygentypedef:: ActorPtr
418 .. group-tab:: Python
422 from simgrid import Actor
428 #include <simgrid/actor.h>
430 .. doxygentypedef:: sg_actor_t
431 .. doxygentypedef:: const_sg_actor_t
432 .. doxygenfunction:: sg_actor_ref
433 .. doxygenfunction:: sg_actor_unref
439 See also :ref:`the relevant example <s4u_ex_actors_create>`.
445 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
446 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
447 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
448 .. doxygenfunction:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
450 .. doxygenfunction:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
451 .. doxygenfunction:: simgrid::s4u::Actor::start(const std::function< void()> &code)
452 .. doxygenfunction:: simgrid::s4u::Actor::set_stacksize
454 .. group-tab:: Python
456 .. automethod:: simgrid.Actor.create
460 .. doxygenfunction:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, char *const *argv)
461 .. doxygenfunction:: sg_actor_init(const char *name, sg_host_t host)
462 .. doxygenfunction:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char *const *argv)
463 .. doxygenfunction:: sg_actor_set_stacksize
465 .. doxygenfunction:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
466 .. doxygenfunction:: sg_actor_detach()
475 .. doxygenfunction:: simgrid::s4u::Actor::by_pid(aid_t pid)
476 .. doxygenfunction:: simgrid::s4u::Actor::self()
478 .. group-tab:: Python
480 .. automethod:: simgrid.Actor.by_pid
481 .. automethod:: simgrid.Actor.self
485 .. doxygenfunction:: sg_actor_by_pid(aid_t pid)
486 .. doxygenfunction:: sg_actor_self()
487 .. doxygenfunction:: sg_actor_list()
496 .. doxygenfunction:: simgrid::s4u::Actor::get_cname
497 .. doxygenfunction:: simgrid::s4u::Actor::get_name
498 .. doxygenfunction:: simgrid::s4u::Actor::get_pid
499 .. doxygenfunction:: simgrid::s4u::Actor::get_ppid
500 .. doxygenfunction:: simgrid::s4u::Actor::get_properties() const
501 .. doxygenfunction:: simgrid::s4u::Actor::get_property(const std::string &key) const
502 .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
504 .. doxygenfunction:: simgrid::s4u::Actor::get_host
505 .. doxygenfunction:: simgrid::s4u::Actor::set_host
507 .. doxygenfunction:: simgrid::s4u::Actor::get_refcount
508 .. doxygenfunction:: simgrid::s4u::Actor::get_impl
510 .. group-tab:: Python
512 .. autoattribute:: simgrid.Actor.name
513 .. autoattribute:: simgrid.Actor.host
514 .. autoattribute:: simgrid.Actor.pid
515 .. autoattribute:: simgrid.Actor.ppid
519 .. doxygenfunction:: sg_actor_get_name(const_sg_actor_t actor)
520 .. doxygenfunction:: sg_actor_get_pid(const_sg_actor_t actor)
521 .. doxygenfunction:: sg_actor_get_ppid(const_sg_actor_t actor)
522 .. doxygenfunction:: sg_actor_get_properties(const_sg_actor_t actor)
523 .. doxygenfunction:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
525 .. doxygenfunction:: sg_actor_get_host(const_sg_actor_t actor)
526 .. doxygenfunction:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
528 .. doxygenfunction:: sg_actor_get_data(const_sg_actor_t actor)
529 .. doxygenfunction:: sg_actor_set_data(sg_actor_t actor, void *userdata)
531 Suspending and resuming actors
532 ------------------------------
538 .. doxygenfunction:: simgrid::s4u::Actor::suspend()
539 .. doxygenfunction:: simgrid::s4u::Actor::resume()
540 .. doxygenfunction:: simgrid::s4u::Actor::is_suspended
542 .. group-tab:: Python
544 .. automethod:: simgrid.Actor.resume
545 .. automethod:: simgrid.Actor.suspend
546 .. automethod:: simgrid.Actor.is_suspended
550 .. doxygenfunction:: sg_actor_suspend(sg_actor_t actor)
551 .. doxygenfunction:: sg_actor_resume(sg_actor_t actor)
552 .. doxygenfunction:: sg_actor_is_suspended(const_sg_actor_t actor)
554 Specifying when actors should terminate
555 ---------------------------------------
561 .. doxygenfunction:: simgrid::s4u::Actor::kill()
562 .. doxygenfunction:: simgrid::s4u::Actor::kill_all()
563 .. doxygenfunction:: simgrid::s4u::Actor::set_kill_time(double time)
564 .. doxygenfunction:: simgrid::s4u::Actor::get_kill_time
566 .. doxygenfunction:: simgrid::s4u::Actor::restart()
567 .. doxygenfunction:: simgrid::s4u::Actor::daemonize()
568 .. doxygenfunction:: simgrid::s4u::Actor::is_daemon
570 .. group-tab:: Python
572 .. automethod:: simgrid.Actor.kill
573 .. automethod:: simgrid.Actor.kill_all
575 .. automethod:: simgrid.Actor.daemonize
576 .. automethod:: simgrid.Actor.is_daemon
580 .. doxygenfunction:: sg_actor_kill(sg_actor_t actor)
581 .. doxygenfunction:: sg_actor_kill_all()
582 .. doxygenfunction:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
584 .. doxygenfunction:: sg_actor_restart(sg_actor_t actor)
585 .. doxygenfunction:: sg_actor_daemonize(sg_actor_t actor)
586 .. doxygenfunction:: sg_actor_is_daemon
588 .. _API_s4u_Actor_end:
590 Reacting to the end of actors
591 -----------------------------
597 .. doxygenfunction:: simgrid::s4u::Actor::on_exit
598 .. doxygenfunction:: simgrid::s4u::Actor::join() const
599 .. doxygenfunction:: simgrid::s4u::Actor::join(double timeout) const
600 .. doxygenfunction:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
602 .. group-tab:: Python
604 .. automethod:: simgrid.Actor.join
608 .. doxygenfunction:: sg_actor_on_exit
609 .. doxygenfunction:: sg_actor_join(const_sg_actor_t actor, double timeout)
610 .. doxygenfunction:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
619 .. doxygenfunction:: simgrid::s4u::Actor::on_creation_cb
620 .. doxygenfunction:: simgrid::s4u::Actor::on_suspend_cb
621 .. doxygenfunction:: simgrid::s4u::Actor::on_host_change_cb
622 .. doxygenfunction:: simgrid::s4u::Actor::on_resume_cb
623 .. doxygenfunction:: simgrid::s4u::Actor::on_sleep_cb
624 .. doxygenfunction:: simgrid::s4u::Actor::on_wake_up_cb
625 .. doxygenfunction:: simgrid::s4u::Actor::on_termination_cb
626 .. doxygenfunction:: simgrid::s4u::Actor::on_destruction_cb
628 .. _API_s4u_this_actor:
634 These functions can be used in your user code to interact with the actor
635 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
636 Using these functions can greatly improve the code readability.
645 .. doxygenfunction:: simgrid::s4u::this_actor::get_cname()
646 .. doxygenfunction:: simgrid::s4u::this_actor::get_name()
647 .. doxygenfunction:: simgrid::s4u::this_actor::get_pid()
648 .. doxygenfunction:: simgrid::s4u::this_actor::get_ppid()
649 .. doxygenfunction:: simgrid::s4u::this_actor::is_maestro()
651 .. doxygenfunction:: simgrid::s4u::this_actor::get_host()
652 .. doxygenfunction:: simgrid::s4u::this_actor::set_host(Host *new_host)
654 .. group-tab:: Python
656 .. autofunction:: simgrid.this_actor.get_host
657 .. autofunction:: simgrid.this_actor.set_host
659 .. autofunction:: simgrid.this_actor.get_pid
660 .. autofunction:: simgrid.this_actor.get_ppid
664 .. doxygenfunction:: sg_actor_self_get_data()
665 .. doxygenfunction:: sg_actor_self_set_data(void *data)
666 .. doxygenfunction:: sg_actor_self_get_name()
667 .. doxygenfunction:: sg_actor_self_get_pid()
668 .. doxygenfunction:: sg_actor_self_get_ppid()
669 .. doxygenfunction:: sg_host_self()
670 .. doxygenfunction:: sg_host_self_get_name()
672 Suspending and resuming
673 -----------------------
679 .. doxygenfunction:: simgrid::s4u::this_actor::suspend()
680 .. doxygenfunction:: simgrid::s4u::this_actor::yield()
682 .. group-tab:: Python
684 .. autofunction:: simgrid.this_actor.suspend
685 .. autofunction:: simgrid.this_actor.yield_
689 .. doxygenfunction:: sg_actor_yield()
698 Please refer to :ref:`the relevant documentation <logging_prog>`.
700 .. group-tab:: Python
702 .. autofunction:: simgrid.this_actor.debug
703 .. autofunction:: simgrid.this_actor.info
704 .. autofunction:: simgrid.this_actor.error
713 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(double duration)
714 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
715 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
716 .. doxygenfunction:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
718 .. group-tab:: Python
720 .. autofunction:: simgrid.this_actor.sleep_for
721 .. autofunction:: simgrid.this_actor.sleep_until
725 .. doxygenfunction:: sg_actor_sleep_for(double duration)
727 Simulating executions
728 ---------------------
730 Simulate the execution of some code on this actor. You can either simulate
731 parallel or sequential code and you can either block upon the termination of
732 the execution, or start an asynchronous activity.
738 .. doxygenfunction:: simgrid::s4u::this_actor::exec_async
739 .. 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)
740 .. doxygenfunction:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
741 .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop)
742 .. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop, double priority)
743 .. 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)
745 .. group-tab:: Python
747 .. autofunction:: simgrid.this_actor.exec_init
748 .. autofunction:: simgrid.this_actor.execute
752 .. doxygenfunction:: sg_actor_execute(double flops)
753 .. doxygenfunction:: sg_actor_execute_with_priority(double flops, double priority)
754 .. doxygenfunction:: sg_actor_exec_init(double computation_amount)
755 .. doxygenfunction:: sg_actor_exec_async(double computation_amount)
756 .. doxygenfunction:: sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount, double* bytes_amount);
765 .. doxygenfunction:: simgrid::s4u::this_actor::exit()
766 .. doxygenfunction:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
768 .. group-tab:: Python
770 .. autofunction:: simgrid.this_actor.exit
771 .. autofunction:: simgrid.this_actor.on_exit
775 See also :cpp:func:`sg_actor_on_exit`.
777 .. doxygenfunction:: sg_actor_exit
789 .. doxygenclass:: simgrid::s4u::Engine
791 .. group-tab:: Python
793 .. autoclass:: simgrid.Engine
802 .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
803 .. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
804 .. doxygenfunction:: simgrid::s4u::Engine::shutdown()
805 .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
807 .. group-tab:: Python
809 .. automethod:: simgrid.Engine.__init__
810 .. autoattribute:: simgrid.Engine.instance
814 .. doxygenfunction:: simgrid_init
823 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
824 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
825 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
826 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
827 .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, const std::string &value)
829 .. doxygenfunction:: simgrid::s4u::Engine::load_deployment
830 .. doxygenfunction:: simgrid::s4u::Engine::load_platform
831 .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name)
832 .. doxygenfunction:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
833 .. doxygenfunction:: simgrid::s4u::Engine::register_default(const std::function< void(int, char **)> &code)
834 .. doxygenfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
836 .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(int, char **)> &code)
837 .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const std::function< void(std::vector< std::string >)> &code)
838 .. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
840 .. group-tab:: Python
842 .. automethod:: simgrid.Engine.load_deployment
843 .. automethod:: simgrid.Engine.load_platform
844 .. automethod:: simgrid.Engine.register_actor
848 .. doxygenfunction:: simgrid_load_deployment
849 .. doxygenfunction:: simgrid_load_platform
850 .. doxygenfunction:: simgrid_register_default
851 .. doxygenfunction:: simgrid_register_function
861 .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
862 .. doxygenfunction:: simgrid::s4u::Engine::run
863 .. doxygenfunction:: simgrid::s4u::Engine::run_until
865 .. group-tab:: Python
867 .. autoattribute:: simgrid.Engine.clock
868 .. automethod:: simgrid.Engine.run
869 .. automethod:: simgrid.Engine.run_until
873 .. doxygenfunction:: simgrid_get_clock
874 .. doxygenfunction:: simgrid_run
875 .. doxygenfunction:: simgrid_run_until
884 .. doxygenfunction:: simgrid::s4u::Engine::get_actor_count
885 .. doxygenfunction:: simgrid::s4u::Engine::get_all_actors
886 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_actors
890 .. doxygenfunction:: sg_actor_count()
899 .. doxygenfunction:: simgrid::s4u::Engine::get_all_hosts
900 .. doxygenfunction:: simgrid::s4u::Engine::get_host_count
901 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_hosts
902 .. doxygenfunction:: simgrid::s4u::Engine::host_by_name
903 .. doxygenfunction:: simgrid::s4u::Engine::host_by_name_or_null
905 .. group-tab:: Python
907 .. autoattribute:: simgrid.Engine.all_hosts
911 See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
920 .. doxygenfunction:: simgrid::s4u::Engine::get_all_links
921 .. doxygenfunction:: simgrid::s4u::Engine::get_link_count
922 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_links
923 .. doxygenfunction:: simgrid::s4u::Engine::link_by_name
924 .. doxygenfunction:: simgrid::s4u::Engine::link_by_name_or_null
926 .. group-tab:: Python
928 .. autoattribute:: simgrid.Engine.all_links
930 Interacting with the routing
931 ----------------------------
937 .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
938 .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
939 .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
940 .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
941 .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
943 .. group-tab:: Python
945 .. autoattribute:: simgrid.Engine.all_netpoints
946 .. autoattribute:: simgrid.Engine.netzone_root
947 .. automethod:: simgrid.Engine.netpoint_by_name
948 .. automethod:: simgrid.Engine.netzone_by_name
957 .. doxygenfunction:: simgrid::s4u::Engine::on_deadlock_cb
958 .. doxygenfunction:: simgrid::s4u::Engine::on_platform_created_cb
959 .. doxygenfunction:: simgrid::s4u::Engine::on_platform_creation_cb
960 .. doxygenfunction:: simgrid::s4u::Engine::on_simulation_end_cb
961 .. doxygenfunction:: simgrid::s4u::Engine::on_time_advance_cb
973 .. doxygenclass:: simgrid::s4u::Mailbox
975 .. group-tab:: Python
977 .. autoclass:: simgrid.Mailbox
979 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
990 #include <simgrid/s4u/Mailbox.hpp>
992 Note that there is no MailboxPtr type and that you cannot use the RAII
993 idiom on mailboxes because they are internal objects to the simulation
994 engine. Once created, there is no way to destroy a mailbox before the end
997 .. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
999 .. group-tab:: Python
1003 #include <simgrid/mailbox.h>
1005 .. automethod:: simgrid.Mailbox.by_name
1011 #include <simgrid/s4u/mailbox.h>
1013 .. doxygentypedef:: sg_mailbox_t
1014 .. doxygentypedef:: const_sg_mailbox_t
1016 .. doxygenfunction:: sg_mailbox_by_name(const char *alias)
1025 .. doxygenfunction:: simgrid::s4u::Mailbox::get_cname
1026 .. doxygenfunction:: simgrid::s4u::Mailbox::get_name
1028 .. group-tab:: Python
1030 .. autoattribute:: simgrid.Mailbox.name
1039 .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
1040 .. doxygenfunction:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
1041 .. doxygenfunction:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
1042 .. doxygenfunction:: simgrid::s4u::Mailbox::put_init()
1043 .. doxygenfunction:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
1045 .. group-tab:: Python
1047 .. automethod:: simgrid.Mailbox.put
1048 .. automethod:: simgrid.Mailbox.put_async
1052 .. doxygenfunction:: sg_mailbox_put(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1053 .. doxygenfunction:: sg_mailbox_put_init(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1054 .. doxygenfunction:: sg_mailbox_put_async(sg_mailbox_t mailbox, void *payload, long simulated_size_in_bytes)
1064 .. doxygenfunction:: simgrid::s4u::Mailbox::empty
1065 .. doxygenfunction:: simgrid::s4u::Mailbox::front
1066 .. doxygenfunction:: simgrid::s4u::Mailbox::get()
1067 .. doxygenfunction:: simgrid::s4u::Mailbox::get(double timeout)
1068 .. doxygenfunction:: simgrid::s4u::Mailbox::get_async(T **data)
1069 .. doxygenfunction:: simgrid::s4u::Mailbox::get_init()
1070 .. doxygenfunction:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
1071 .. doxygenfunction:: simgrid::s4u::Mailbox::listen
1072 .. doxygenfunction:: simgrid::s4u::Mailbox::ready
1074 .. group-tab:: Python
1076 .. automethod:: simgrid.Mailbox.get
1077 .. automethod:: simgrid.Mailbox.get_async
1081 .. doxygenfunction:: sg_mailbox_get(sg_mailbox_t mailbox)
1082 .. doxygenfunction:: sg_mailbox_get_async(sg_mailbox_t mailbox, void **data)
1083 .. doxygenfunction:: sg_mailbox_get_name(const_sg_mailbox_t mailbox)
1084 .. doxygenfunction:: sg_mailbox_listen(const char *alias)
1089 See :ref:`s4u_receiving_actor`.
1095 .. doxygenfunction:: simgrid::s4u::Mailbox::get_receiver
1096 .. doxygenfunction:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
1100 .. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
1102 .. _API_s4u_Resource:
1118 .. doxygenclass:: simgrid::s4u::Disk
1120 .. group-tab:: Python
1122 .. autoclass:: simgrid.Disk
1126 .. doxygentypedef:: sg_disk_t
1127 .. doxygentypedef:: const_sg_disk_t
1138 #include <simgrid/s4u/Disk.hpp>
1140 Note that there is no DiskPtr type and that you cannot use the RAII
1141 idiom on disks because SimGrid does not allow (yet) to create nor
1142 destroy resources once the simulation is started.
1144 .. doxygenfunction:: simgrid::s4u::Disk::seal()
1146 .. group-tab:: Python
1150 from simgrid import Disk
1152 .. automethod:: simgrid.Disk.seal
1162 .. doxygenfunction:: simgrid::s4u::Disk::get_cname() const
1163 .. doxygenfunction:: simgrid::s4u::Disk::get_host() const
1164 .. doxygenfunction:: simgrid::s4u::Disk::get_name() const
1165 .. doxygenfunction:: simgrid::s4u::Disk::get_properties() const
1166 .. doxygenfunction:: simgrid::s4u::Disk::get_property(const std::string &key) const
1167 .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
1168 .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
1169 .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1170 .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1172 .. group-tab:: Python
1174 .. autoattribute:: simgrid.Disk.name
1175 .. automethod:: simgrid.Disk.set_sharing_policy
1184 .. doxygenfunction:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type) const
1185 .. doxygenfunction:: simgrid::s4u::Disk::read(sg_size_t size) const
1186 .. doxygenfunction:: simgrid::s4u::Disk::read_async(sg_size_t size) const
1187 .. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
1188 .. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
1190 .. group-tab:: Python
1192 .. automethod:: simgrid.Disk.read
1193 .. automethod:: simgrid.Disk.read_async
1194 .. automethod:: simgrid.Disk.write
1195 .. automethod:: simgrid.Disk.write_async
1204 .. doxygenfunction:: simgrid::s4u::Disk::on_creation_cb
1205 .. doxygenfunction:: simgrid::s4u::Disk::on_destruction_cb
1206 .. doxygenfunction:: simgrid::s4u::Disk::on_state_change_cb
1219 .. doxygenclass:: simgrid::s4u::Host
1221 .. group-tab:: Python
1223 .. autoclass:: simgrid.Host
1234 #include <simgrid/s4u/Host.hpp>
1236 Note that there is no HostPtr type, and that you cannot use the RAII
1237 idiom on hosts because SimGrid does not allow (yet) to create nor
1238 destroy resources once the simulation is started.
1240 .. doxygenfunction:: simgrid::s4u::Host::destroy()
1241 .. doxygenfunction:: simgrid::s4u::Host::seal()
1243 .. group-tab:: Python
1247 from simgrid import Host
1249 .. automethod:: simgrid.Host.seal
1255 #include <simgrid/host.h>
1257 .. doxygentypedef:: sg_host_t
1258 .. cpp:type:: const s4u_Host* const_sg_host_t
1260 Pointer to a constant host object.
1269 See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1271 .. doxygenfunction:: simgrid::s4u::Host::by_name(const std::string &name)
1272 .. doxygenfunction:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1273 .. doxygenfunction:: simgrid::s4u::Host::current()
1275 .. group-tab:: Python
1277 See also :py:attr:`simgrid.Engine.all_hosts`.
1279 .. automethod:: simgrid.Host.by_name
1280 .. automethod:: simgrid.Host.current
1284 .. doxygenfunction:: sg_host_by_name(const char *name)
1285 .. doxygenfunction:: sg_host_count()
1286 .. doxygenfunction:: sg_host_list()
1288 Modifying characteristics
1289 -------------------------
1295 .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count)
1296 .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords)
1297 .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
1299 .. group-tab:: Python
1301 .. autoattribute:: simgrid.Host.core_count
1302 .. automethod:: simgrid.Host.set_coordinates
1303 .. automethod:: simgrid.Host.set_sharing_policy
1312 .. doxygenfunction:: simgrid::s4u::Host::get_cname() const
1313 .. doxygenfunction:: simgrid::s4u::Host::get_core_count() const
1314 .. doxygenfunction:: simgrid::s4u::Host::get_name() const
1315 .. doxygenfunction:: simgrid::s4u::Host::get_available_speed() const
1316 .. doxygenfunction:: simgrid::s4u::Host::get_load() const
1317 .. doxygenfunction:: simgrid::s4u::Host::get_speed() const
1319 .. group-tab:: Python
1321 .. autoattribute:: simgrid.Host.name
1322 .. autoattribute:: simgrid.Host.core_count
1323 .. autoattribute:: simgrid.Host.load
1324 .. autoattribute:: simgrid.Host.pstate
1325 .. autoattribute:: simgrid.Host.speed
1326 .. autoattribute:: simgrid.Host.available_speed
1330 .. doxygenfunction:: sg_host_core_count(const_sg_host_t host)
1331 .. doxygenfunction:: sg_host_get_name(const_sg_host_t host)
1332 .. doxygenfunction:: sg_host_get_load(const_sg_host_t host)
1333 .. doxygenfunction:: sg_host_get_speed(const_sg_host_t host)
1335 User data and properties
1336 ------------------------
1342 .. doxygenfunction:: simgrid::s4u::Host::get_properties() const
1343 .. doxygenfunction:: simgrid::s4u::Host::get_property(const std::string &key) const
1344 .. doxygenfunction:: simgrid::s4u::Host::set_properties(const std::unordered_map< std::string, std::string > &properties)
1345 .. doxygenfunction:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1349 .. doxygenfunction:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1350 .. doxygenfunction:: sg_host_get_properties(const_sg_host_t host)
1351 .. doxygenfunction:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1352 .. doxygenfunction:: sg_host_extension_create(void(*deleter)(void *))
1353 .. doxygenfunction:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1355 Retrieving components
1356 ---------------------
1362 .. doxygenfunction:: simgrid::s4u::Host::add_disk(const Disk *disk)
1363 .. doxygenfunction:: simgrid::s4u::Host::get_actor_count() const
1364 .. doxygenfunction:: simgrid::s4u::Host::get_all_actors() const
1365 .. doxygenfunction:: simgrid::s4u::Host::get_disks() const
1366 .. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1368 .. group-tab:: Python
1370 .. automethod:: simgrid.Host.get_disks
1374 .. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1383 .. doxygenfunction:: simgrid::s4u::Host::is_on() const
1384 .. doxygenfunction:: simgrid::s4u::Host::turn_off()
1385 .. doxygenfunction:: simgrid::s4u::Host::turn_on()
1389 .. doxygenfunction:: sg_host_is_on(const_sg_host_t host)
1390 .. doxygenfunction:: sg_host_turn_off(sg_host_t host)
1391 .. doxygenfunction:: sg_host_turn_on(sg_host_t host)
1400 .. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
1401 .. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
1402 .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(unsigned long pstate_index) const
1403 .. doxygenfunction:: simgrid::s4u::Host::set_pstate(unsigned long pstate_index)
1405 .. group-tab:: Python
1407 .. autoattribute:: simgrid.Host.pstate_count
1408 .. automethod:: simgrid.Host.pstate_speed
1412 .. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
1413 .. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
1414 .. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
1415 .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
1416 .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, unsigned long pstate)
1425 .. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1426 .. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1428 .. group-tab:: Python
1430 .. automethod:: simgrid.Host.set_speed_profile
1431 .. automethod:: simgrid.Host.set_state_profile
1440 .. doxygenfunction:: simgrid::s4u::Host::exec_async
1441 .. doxygenfunction:: simgrid::s4u::Host::execute(double flops) const
1442 .. doxygenfunction:: simgrid::s4u::Host::execute(double flops, double priority) const
1444 Platform and routing
1445 --------------------
1447 You can also start direct communications between two arbitrary hosts
1448 using :cpp:func:`Comm::sendto() <simgrid::s4u::Comm::sendto()>`.
1454 .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const
1455 .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
1456 .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
1457 .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::StandardLinkImpl * > &links, double *latency) const
1458 .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
1459 .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
1461 .. group-tab:: Python
1463 .. autoattribute:: simgrid.Host.netpoint
1464 .. automethod:: simgrid.Host.create_disk
1466 .. automethod:: simgrid.Host.route_to
1470 .. doxygenfunction:: sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1471 .. doxygenfunction:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1472 .. doxygenfunction:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
1473 .. doxygenfunction:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1482 .. doxygenfunction:: simgrid::s4u::Host::on_creation_cb
1483 .. doxygenfunction:: simgrid::s4u::Host::on_destruction_cb
1484 .. doxygenfunction:: simgrid::s4u::Host::on_speed_change_cb
1485 .. doxygenfunction:: simgrid::s4u::Host::on_state_change_cb
1497 .. doxygenclass:: simgrid::s4u::Link
1498 .. doxygenclass:: simgrid::s4u::SplitDuplexLink
1499 .. doxygenclass:: simgrid::s4u::LinkInRoute
1502 .. group-tab:: Python
1504 .. autoclass:: simgrid.Link
1515 #include <simgrid/s4u/Link.hpp>
1517 Note that there is no LinkPtr type and that you cannot use the RAII
1518 idiom on hosts because SimGrid does not allow (yet) to create nor
1519 destroy resources once the simulation is started.
1521 .. doxygenfunction:: simgrid::s4u::Link::seal()
1523 .. group-tab:: Python
1527 from simgrid import Link
1529 .. automethod:: simgrid.Link.seal
1535 #include <simgrid/link.h>
1537 .. doxygentypedef:: sg_link_t
1538 .. cpp:type:: const s4u_Link* const_sg_link_t
1540 Pointer to a constant link object.
1549 See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1551 .. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
1552 .. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1554 .. group-tab:: Python
1556 See also :py:attr:`simgrid.Engine.all_links`.
1558 .. automethod:: simgrid.Link.by_name
1559 .. autoattribute:: simgrid.Link.name
1563 .. doxygenfunction:: sg_link_by_name(const char *name)
1564 .. doxygenfunction:: sg_link_count()
1565 .. doxygenfunction:: sg_link_list()
1574 .. doxygenfunction:: simgrid::s4u::Link::get_bandwidth() const
1575 .. doxygenfunction:: simgrid::s4u::Link::get_cname() const
1576 .. doxygenfunction:: simgrid::s4u::Link::get_latency() const
1577 .. doxygenfunction:: simgrid::s4u::Link::get_name() const
1578 .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const
1579 .. doxygenfunction:: simgrid::s4u::Link::get_usage() const
1580 .. doxygenfunction:: simgrid::s4u::Link::is_used() const
1582 .. group-tab:: Python
1584 .. autoattribute:: simgrid.Link.bandwidth
1585 .. autoattribute:: simgrid.Link.latency
1589 .. doxygenfunction:: sg_link_get_bandwidth(const_sg_link_t link)
1590 .. doxygenfunction:: sg_link_get_latency(const_sg_link_t link)
1591 .. doxygenfunction:: sg_link_get_name(const_sg_link_t link)
1592 .. doxygenfunction:: sg_link_is_shared(const_sg_link_t link)
1594 Modifying characteristics
1595 -------------------------
1601 .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
1602 .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
1603 .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value)
1604 .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit)
1605 .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {})
1607 .. group-tab:: Python
1609 .. automethod:: simgrid.Link.set_bandwidth
1610 .. automethod:: simgrid.Link.set_latency
1611 .. automethod:: simgrid.Link.set_concurrency_limit
1612 .. automethod:: simgrid.Link.set_sharing_policy
1616 .. doxygenfunction:: sg_link_set_bandwidth(sg_link_t link, double value)
1617 .. doxygenfunction:: sg_link_set_latency(sg_link_t link, double value)
1619 User data and properties
1620 ------------------------
1626 .. doxygenfunction:: simgrid::s4u::Link::get_property(const std::string &key) const
1627 .. doxygenfunction:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1631 .. doxygenfunction:: sg_link_get_data(const_sg_link_t link)
1632 .. doxygenfunction:: sg_link_set_data(sg_link_t link, void *data)
1641 See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1643 .. doxygenfunction:: simgrid::s4u::Link::is_on() const
1644 .. doxygenfunction:: simgrid::s4u::Link::turn_off()
1645 .. doxygenfunction:: simgrid::s4u::Link::turn_on()
1647 .. group-tab:: Python
1649 See also :py:func:`simgrid.Link.set_state_profile`.
1651 .. automethod:: simgrid.Link.is_on
1652 .. automethod:: simgrid.Link.turn_off
1653 .. automethod:: simgrid.Link.turn_on
1658 See :ref:`howto_churn` for more details.
1664 .. doxygenfunction:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1665 .. doxygenfunction:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1666 .. doxygenfunction:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1668 .. group-tab:: Python
1670 .. automethod:: simgrid.Link.set_bandwidth_profile
1671 .. automethod:: simgrid.Link.set_latency_profile
1672 .. automethod:: simgrid.Link.set_state_profile
1681 .. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
1683 .. group-tab:: Python
1685 .. automethod:: simgrid.Link.set_host_wifi_rate
1694 .. doxygenfunction:: simgrid::s4u::Link::on_bandwidth_change_cb
1695 .. doxygenfunction:: simgrid::s4u::Link::on_communication_state_change_cb
1696 .. doxygenfunction:: simgrid::s4u::Link::on_creation_cb
1697 .. doxygenfunction:: simgrid::s4u::Link::on_destruction_cb
1698 .. doxygenfunction:: simgrid::s4u::Link::on_state_change_cb
1700 .. _API_s4u_NetZone:
1710 .. doxygenclass:: simgrid::s4u::NetZone
1712 .. group-tab:: Python
1714 .. autoclass:: simgrid.NetZone
1725 #include <simgrid/s4u/NetZone.hpp>
1727 Note that there is no NetZonePtr type and that you cannot use the RAII
1728 idiom on network zones because SimGrid does not allow (yet) to create nor
1729 destroy resources once the simulation is started.
1731 .. doxygenfunction:: simgrid::s4u::NetZone::seal
1733 .. group-tab:: Python
1737 from simgrid import NetZone
1739 .. automethod:: simgrid.NetZone.seal
1745 #include <simgrid/zone.h>
1747 .. doxygentypedef:: sg_netzone_t
1748 .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1750 Pointer to a constant network zone object.
1759 See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1760 :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1761 :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1765 .. doxygenfunction:: sg_zone_get_by_name(const char *name)
1766 .. doxygenfunction:: sg_zone_get_root()
1775 .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
1776 .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
1777 .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint()
1779 .. group-tab:: Python
1781 .. autoattribute:: simgrid.NetZone.name
1782 .. autoattribute:: simgrid.NetZone.netpoint
1786 .. doxygenfunction:: sg_zone_get_name(const_sg_netzone_t zone)
1788 User data and properties
1789 ------------------------
1795 .. doxygenfunction:: simgrid::s4u::NetZone::get_properties() const
1796 .. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1797 .. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1799 .. group-tab:: Python
1801 .. automethod:: simgrid.NetZone.set_property
1805 .. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1806 .. doxygenfunction:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1808 Retrieving components
1809 ---------------------
1815 .. doxygenfunction:: simgrid::s4u::NetZone::get_all_hosts() const
1816 .. doxygenfunction:: simgrid::s4u::NetZone::get_host_count() const
1820 .. doxygenfunction:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1829 .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1830 .. doxygenfunction:: simgrid::s4u::NetZone::add_route
1831 .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
1832 .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
1833 .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
1834 .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent)
1836 .. group-tab:: Python
1838 .. automethod:: simgrid.NetZone.add_route
1839 .. automethod:: simgrid.NetZone.set_parent
1843 .. doxygenfunction:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1852 .. doxygenfunction:: simgrid::s4u::NetZone::on_creation_cb
1853 .. doxygenfunction:: simgrid::s4u::NetZone::on_seal_cb
1864 .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name)
1865 .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name)
1866 .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name)
1867 .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache)
1868 .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name)
1869 .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name)
1870 .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name)
1871 .. doxygenfunction:: simgrid::s4u::create_torus_zone
1872 .. doxygenfunction:: simgrid::s4u::create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
1873 .. doxygenfunction:: simgrid::s4u::create_dragonfly_zone(const std::string& name, const NetZone* parent, const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
1875 .. group-tab:: Python
1877 .. automethod:: simgrid.NetZone.create_full_zone
1878 .. automethod:: simgrid.NetZone.create_empty_zone
1879 .. automethod:: simgrid.NetZone.create_star_zone
1880 .. automethod:: simgrid.NetZone.create_dijkstra_zone
1881 .. automethod:: simgrid.NetZone.create_floyd_zone
1882 .. automethod:: simgrid.NetZone.create_vivaldi_zone
1883 .. automethod:: simgrid.NetZone.create_wifi_zone
1884 .. automethod:: simgrid.NetZone.create_torus_zone
1885 .. automethod:: simgrid.NetZone.create_fatTree_zone
1886 .. automethod:: simgrid.NetZone.create_dragonfly_zone
1895 .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
1896 .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed)
1897 .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
1898 .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed)
1900 .. group-tab:: Python
1902 .. automethod:: simgrid.NetZone.create_host
1911 .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
1912 .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth)
1913 .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidthds)
1914 .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth)
1915 .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
1916 .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
1918 .. group-tab:: Python
1920 .. automethod:: simgrid.NetZone.create_link
1921 .. automethod:: simgrid.NetZone.create_split_duplex_link
1930 .. doxygenfunction:: simgrid::s4u::NetZone::create_router(const std::string& name)
1932 .. group-tab:: Python
1934 .. automethod:: simgrid.NetZone.create_router
1936 .. _API_s4u_VirtualMachine:
1938 =======================
1939 class VirtualMachine
1940 =======================
1943 .. doxygenclass:: simgrid::s4u::VirtualMachine
1953 #include <simgrid/s4u/VirtualMachine.hpp>
1955 Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1956 idiom on virtual machines. There is no good reason for that and should change in the future.
1962 #include <simgrid/vm.h>
1964 .. doxygentypedef:: sg_vm_t
1965 .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1967 Pointer to a constant virtual machine object.
1976 .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount)
1977 .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount, size_t ramsize)
1978 .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
1982 .. doxygenfunction:: sg_vm_create_core
1983 .. doxygenfunction:: sg_vm_create_multicore
1984 .. doxygenfunction:: sg_vm_destroy
1993 .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_pm() const
1994 .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_ramsize() const
1995 .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_state() const
1997 .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1998 .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1999 .. doxygenfunction:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
2003 .. doxygenfunction:: sg_vm_get_ramsize(const_sg_vm_t vm)
2004 .. doxygenfunction:: sg_vm_set_bound(sg_vm_t vm, double bound)
2005 .. doxygenfunction:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
2007 .. doxygenfunction:: sg_vm_get_name
2008 .. doxygenfunction:: sg_vm_get_pm
2009 .. doxygenfunction:: sg_vm_is_created
2010 .. doxygenfunction:: sg_vm_is_running
2011 .. doxygenfunction:: sg_vm_is_suspended
2020 .. doxygenfunction:: simgrid::s4u::VirtualMachine::resume()
2021 .. doxygenfunction:: simgrid::s4u::VirtualMachine::shutdown()
2022 .. doxygenfunction:: simgrid::s4u::VirtualMachine::start()
2023 .. doxygenfunction:: simgrid::s4u::VirtualMachine::suspend()
2027 .. doxygenfunction:: sg_vm_start
2028 .. doxygenfunction:: sg_vm_suspend
2029 .. doxygenfunction:: sg_vm_resume
2030 .. doxygenfunction:: sg_vm_shutdown
2039 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_creation_cb
2040 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_destruction_cb
2041 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_migration_end_cb
2042 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_migration_start_cb
2043 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_resume_cb
2044 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_shutdown_cb
2045 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_start_cb
2046 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_started_cb
2047 .. doxygenfunction:: simgrid::s4u::VirtualMachine::on_suspend_cb
2049 .. _API_s4u_Activity:
2059 .. doxygenclass:: simgrid::s4u::Activity
2061 **Known subclasses:**
2062 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
2063 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
2064 :ref:`I/O <API_s4u_Io>` (started on and consuming disks).
2065 See also the :ref:`section on activities <s4u_Activities>` above.
2076 #include <simgrid/s4u/Activity.hpp>
2078 .. doxygentypedef:: ActivityPtr
2087 .. doxygenfunction:: simgrid::s4u::Activity::get_cname
2088 .. doxygenfunction:: simgrid::s4u::Activity::get_name
2089 .. doxygenfunction:: simgrid::s4u::Activity::get_remaining() const
2090 .. doxygenfunction:: simgrid::s4u::Activity::get_state() const
2091 .. doxygenfunction:: simgrid::s4u::Activity::set_remaining(double remains)
2092 .. doxygenfunction:: simgrid::s4u::Activity::set_state(Activity::State state)
2095 Activities life cycle
2096 ---------------------
2102 .. doxygenfunction:: simgrid::s4u::Activity::start
2103 .. doxygenfunction:: simgrid::s4u::Activity::cancel
2104 .. doxygenfunction:: simgrid::s4u::Activity::test
2105 .. doxygenfunction:: simgrid::s4u::Activity::wait
2106 .. doxygenfunction:: simgrid::s4u::Activity::wait_for
2107 .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit)
2108 .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start()
2110 Suspending and resuming an activity
2111 -----------------------------------
2117 .. doxygenfunction:: simgrid::s4u::Activity::suspend
2118 .. doxygenfunction:: simgrid::s4u::Activity::resume
2119 .. doxygenfunction:: simgrid::s4u::Activity::is_suspended
2131 .. doxygenclass:: simgrid::s4u::Comm
2133 .. group-tab:: Python
2135 .. autoclass:: simgrid.Comm
2146 #include <simgrid/s4u/Comm.hpp>
2148 .. doxygentypedef:: CommPtr
2150 .. group-tab:: Python
2154 from simgrid import Comm
2160 #include <simgrid/comm.h>
2162 .. doxygentypedef:: sg_comm_t
2163 .. doxygentypedef:: const_sg_comm_t
2172 .. doxygenfunction:: simgrid::s4u::Comm::get_dst_data_size() const
2173 .. doxygenfunction:: simgrid::s4u::Comm::get_mailbox() const
2174 .. doxygenfunction:: simgrid::s4u::Comm::get_sender() const
2175 .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff)
2176 .. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
2177 .. doxygenfunction:: simgrid::s4u::Comm::detach()
2178 .. doxygenfunction:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
2179 .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(uint64_t bytes)
2180 .. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
2181 .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
2182 .. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
2183 .. doxygenfunction:: simgrid::s4u::Comm::set_src_data_size(size_t size)
2188 Most communications are created using :ref:`s4u_mailbox`, but you can
2189 also start direct communications as shown below.
2195 .. doxygenfunction:: simgrid::s4u::Comm::sendto
2196 .. doxygenfunction:: simgrid::s4u::Comm::sendto_init()
2197 .. doxygenfunction:: simgrid::s4u::Comm::sendto_init(Host *from, Host *to)
2198 .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
2200 .. doxygenfunction:: simgrid::s4u::Comm::cancel
2201 .. doxygenfunction:: simgrid::s4u::Comm::start
2202 .. doxygenfunction:: simgrid::s4u::Comm::test
2203 .. doxygenfunction:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr >& comms)
2204 .. doxygenfunction:: simgrid::s4u::Comm::wait
2205 .. doxygenfunction:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr >& comms)
2206 .. doxygenfunction:: simgrid::s4u::Comm::wait_all_for(const std::vector< CommPtr >& comms, double timeout)
2207 .. doxygenfunction:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr >& comms)
2208 .. doxygenfunction:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr >& comms, double timeout)
2209 .. doxygenfunction:: simgrid::s4u::Comm::wait_for
2211 .. group-tab:: Python
2213 .. automethod:: simgrid.Comm.test
2214 .. automethod:: simgrid.Comm.wait
2215 .. automethod:: simgrid.Comm.wait_all
2216 .. automethod:: simgrid.Comm.wait_any
2220 .. doxygenfunction:: sg_comm_test
2221 .. doxygenfunction:: sg_comm_wait
2222 .. doxygenfunction:: sg_comm_wait_all
2223 .. doxygenfunction:: sg_comm_wait_any
2232 .. doxygenfunction:: simgrid::s4u::Comm::on_start_cb
2233 .. doxygenfunction:: simgrid::s4u::Comm::on_completion_cb
2234 .. doxygenfunction:: simgrid::s4u::Comm::on_recv_cb
2235 .. doxygenfunction:: simgrid::s4u::Comm::on_send_cb
2247 .. doxygenclass:: simgrid::s4u::Exec
2249 .. group-tab:: Python
2251 .. autoclass:: simgrid.Exec
2262 #include <simgrid/s4u/Exec.hpp>
2264 .. doxygentypedef:: ExecPtr
2266 .. group-tab:: Python
2270 from simgrid import Exec
2276 #include <simgrid/exec.h>
2278 .. doxygentypedef:: sg_exec_t
2279 .. doxygentypedef:: const_sg_exec_t
2288 .. doxygenfunction:: simgrid::s4u::Exec::get_cost() const
2289 .. doxygenfunction:: simgrid::s4u::Exec::get_finish_time() const
2290 .. doxygenfunction:: simgrid::s4u::Exec::get_host() const
2291 .. doxygenfunction:: simgrid::s4u::Exec::get_host_number() const
2292 .. doxygenfunction:: simgrid::s4u::Exec::get_remaining
2293 .. doxygenfunction:: simgrid::s4u::Exec::get_remaining_ratio
2294 .. doxygenfunction:: simgrid::s4u::Exec::get_start_time() const
2295 .. doxygenfunction:: simgrid::s4u::Exec::set_bound(double bound)
2296 .. doxygenfunction:: simgrid::s4u::Exec::set_host
2297 .. doxygenfunction:: simgrid::s4u::Exec::set_priority(double priority)
2299 .. group-tab:: Python
2301 .. autoattribute:: simgrid.Exec.host
2302 .. autoattribute:: simgrid.Exec.remaining
2303 .. autoattribute:: simgrid.Exec.remaining_ratio
2307 .. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
2308 .. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
2309 .. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
2310 .. doxygenfunction:: sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
2311 .. doxygenfunction:: sg_exec_get_remaining(const_sg_exec_t exec)
2312 .. doxygenfunction:: sg_exec_get_remaining_ratio(const_sg_exec_t exec)
2321 .. doxygenfunction:: simgrid::s4u::Exec::cancel
2322 .. doxygenfunction:: simgrid::s4u::Exec::start
2323 .. doxygenfunction:: simgrid::s4u::Exec::test
2324 .. doxygenfunction:: simgrid::s4u::Exec::wait
2325 .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs)
2326 .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout)
2327 .. doxygenfunction:: simgrid::s4u::Exec::wait_for
2329 .. group-tab:: Python
2331 .. automethod:: simgrid.Exec.cancel
2332 .. automethod:: simgrid.Exec.start
2333 .. automethod:: simgrid.Exec.test
2334 .. automethod:: simgrid.Exec.wait
2338 .. doxygenfunction:: sg_exec_start(sg_exec_t exec)
2339 .. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
2340 .. doxygenfunction:: sg_exec_test(sg_exec_t exec);
2341 .. doxygenfunction:: sg_exec_wait(sg_exec_t exec);
2342 .. doxygenfunction:: sg_exec_wait_for(sg_exec_t exec, double timeout);
2343 .. doxygenfunction:: sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout);
2344 .. doxygenfunction:: sg_exec_wait_any(sg_exec_t* execs, size_t count);
2353 .. doxygenfunction:: simgrid::s4u::Exec::on_start_cb
2354 .. doxygenfunction:: simgrid::s4u::Exec::on_completion_cb
2366 .. doxygenclass:: simgrid::s4u::Io
2368 .. group-tab:: Python
2370 .. autoclass:: simgrid.Io
2381 #include <simgrid/s4u/Io.hpp>
2383 .. doxygentypedef:: IoPtr
2392 .. doxygenfunction:: simgrid::s4u::Io::get_performed_ioops() const
2393 .. doxygenfunction:: simgrid::s4u::Io::get_remaining
2402 .. doxygenfunction:: simgrid::s4u::Io::cancel
2403 .. doxygenfunction:: simgrid::s4u::Io::start
2404 .. doxygenfunction:: simgrid::s4u::Io::test
2405 .. doxygenfunction:: simgrid::s4u::Io::wait
2406 .. doxygenfunction:: simgrid::s4u::Io::wait_for
2407 .. doxygenfunction:: simgrid::s4u::Io::wait_any
2408 .. doxygenfunction:: simgrid::s4u::Io::wait_any_for
2410 .. group-tab:: Python
2412 .. automethod:: simgrid.Io.test
2413 .. automethod:: simgrid.Io.wait
2414 .. automethod:: simgrid.Io.wait_any_for
2415 .. automethod:: simgrid.Io.wait_any
2424 .. doxygenfunction:: simgrid::s4u::Io::on_start_cb
2425 .. doxygenfunction:: simgrid::s4u::Io::on_completion_cb
2427 .. _API_s4u_Synchronizations:
2429 =======================
2430 Synchronization Objects
2431 =======================
2439 .. doxygenclass:: simgrid::s4u::Mutex
2450 #include <simgrid/s4u/Mutex.hpp>
2452 .. doxygentypedef:: MutexPtr
2454 .. doxygenfunction:: simgrid::s4u::Mutex::create()
2460 #include <simgrid/mutex.h>
2462 .. doxygentypedef:: sg_mutex_t
2463 .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
2465 Pointer to a constant mutex object.
2467 .. doxygenfunction:: sg_mutex_init()
2468 .. doxygenfunction:: sg_mutex_destroy(const_sg_mutex_t mutex)
2477 .. doxygenfunction:: simgrid::s4u::Mutex::lock()
2478 .. doxygenfunction:: simgrid::s4u::Mutex::try_lock()
2479 .. doxygenfunction:: simgrid::s4u::Mutex::unlock()
2483 .. doxygenfunction:: sg_mutex_lock(sg_mutex_t mutex)
2484 .. doxygenfunction:: sg_mutex_try_lock(sg_mutex_t mutex)
2485 .. doxygenfunction:: sg_mutex_unlock(sg_mutex_t mutex)
2487 .. _API_s4u_Barrier:
2493 .. doxygenclass:: simgrid::s4u::Barrier
2501 #include <simgrid/s4u/Barrier.hpp>
2503 .. doxygentypedef:: BarrierPtr
2505 .. doxygenfunction:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2506 .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2507 .. doxygenfunction:: simgrid::s4u::Barrier::wait()
2513 #include <simgrid/barrier.hpp>
2515 .. doxygentypedef:: sg_bar_t
2516 .. doxygentypedef:: const_sg_bar_t
2518 .. doxygenfunction:: sg_barrier_init(unsigned int count)
2519 .. doxygenfunction:: sg_barrier_destroy(const_sg_bar_t bar)
2520 .. doxygenfunction:: sg_barrier_wait(sg_bar_t bar)
2523 .. _API_s4u_ConditionVariable:
2525 ==========================
2526 Condition variable
2527 ==========================
2529 .. doxygenclass:: simgrid::s4u::ConditionVariable
2540 #include <simgrid/s4u/ConditionVariable.hpp>
2542 .. doxygentypedef:: ConditionVariablePtr
2544 .. doxygenfunction:: simgrid::s4u::ConditionVariable::create()
2550 #include <simgrid/cond.h>
2552 .. doxygentypedef:: sg_cond_t
2553 .. doxygentypedef:: const_sg_cond_t
2554 .. doxygenfunction:: sg_cond_init
2555 .. doxygenfunction:: sg_cond_destroy
2557 Waiting and notifying
2558 ---------------------
2564 .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_all()
2565 .. doxygenfunction:: simgrid::s4u::ConditionVariable::notify_one()
2566 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2567 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2568 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2569 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2570 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2571 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2572 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2573 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2574 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2575 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2576 .. doxygenfunction:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2580 .. doxygenfunction:: sg_cond_notify_all
2581 .. doxygenfunction:: sg_cond_notify_one
2582 .. doxygenfunction:: sg_cond_wait
2583 .. doxygenfunction:: sg_cond_wait_for
2585 .. _API_s4u_Semaphore:
2591 .. doxygenclass:: simgrid::s4u::Semaphore
2603 #include <simgrid/s4u/Semaphore.hpp>
2605 .. doxygentypedef:: SemaphorePtr
2606 .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2612 #include <simgrid/semaphore.h>
2614 .. doxygentypedef:: sg_sem_t
2615 .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2617 Pointer to a constant semaphore object.
2619 .. doxygenfunction:: sg_sem_init(int initial_value)
2620 .. doxygenfunction:: sg_sem_destroy(const_sg_sem_t sem)
2629 .. doxygenfunction:: simgrid::s4u::Semaphore::acquire()
2630 .. doxygenfunction:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2631 .. doxygenfunction:: simgrid::s4u::Semaphore::get_capacity() const
2632 .. doxygenfunction:: simgrid::s4u::Semaphore::release()
2633 .. doxygenfunction:: simgrid::s4u::Semaphore::would_block() const
2637 .. doxygenfunction:: sg_sem_acquire(sg_sem_t sem)
2638 .. doxygenfunction:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2639 .. doxygenfunction:: sg_sem_get_capacity(const_sg_sem_t sem)
2640 .. doxygenfunction:: sg_sem_release(sg_sem_t sem)
2641 .. doxygenfunction:: sg_sem_would_block(const_sg_sem_t sem)