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 definitely the way to go for long-term
24 projects. It is feature complete, but may still evolve slightly in the
25 future releases. It can already be used to do everything that can be
26 done in SimGrid, but you may have to adapt your code in future
27 releases. When this happens, compiling your code will produce
28 deprecation warnings for 4 releases (one year) before the removal of
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 rendez-vous point between
49 communicating actors. This means that you don't need to know who you
50 are talking to, you just put your communication `Put` request in a
51 mailbox, and it will be matched with a complementary `Get`
52 request. Alternatively, actors can interact through **classical
53 synchronization mechanisms** such as |API_s4u_Barrier|_, |API_s4u_Semaphore|_,
54 |API_s4u_Mutex|_ and |API_s4u_ConditionVariable|_.
56 Each actor is located on a simulated |API_s4u_Host|_. Each host is located
57 itself in a |API_s4u_NetZone|_, that knows the networking path between one
58 resource to another. Each NetZone is included in another one, forming
59 a tree of NetZones which root zone contains the whole platform. The
60 actors can also be located on a |API_s4U_VirtualMachine|_ that may
61 restrict the activities it contains to a limited amount of cores.
62 Virtual machines can also be migrated between hosts.
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 rendez-vous, 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 consumming 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 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>`.
174 wait_for and wait_until are currently not implemented for Exec and Io activities.
176 Every kind of activity can be asynchronous:
178 - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
179 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
180 :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`.
181 - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
182 :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
183 :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`.
184 - :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
185 :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
186 - In the future, it will become possible to have asynchronous IPC
187 such as asynchronous mutex lock requests.
189 The following example shows how to have several concurrent
190 communications ongoing. First, you have to declare a vector in which
191 we will store the ongoing communications. It is also useful to have a
194 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
196 :start-after: init-begin
197 :end-before: init-end
200 Then, you start all the communications that should occur concurrently with
201 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
202 Finally, the actor waits for the completion of all of them at once
204 :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
206 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
208 :start-after: put-begin
213 =====================
214 Activities Life cycle
215 =====================
217 Sometimes, you want to change the setting of an activity before it even starts.
219 .. todo:: write this section
226 Please also refer to the :ref:`API reference for s4u::Mailbox
233 |API_s4u_Mailboxes|_ are rendez-vous points for network communications,
234 similar to URLs on which you could post and retrieve data. Actually,
235 the mailboxes are not involved in the communication once it starts,
236 but only to find the contact with which you want to communicate.
238 They are similar to many common things: The phone number, which allows
239 the caller to find the receiver. The twitter hashtag, which help
240 senders and receivers to find each others. In TCP, the pair
241 ``{host name, host port}`` to which you can connect to find your peer.
242 In HTTP, URLs through which the clients can connect to the servers.
243 In ZeroMQ, the queues are used to match senders and receivers.
245 One big difference with most of these systems is that no actor is the
246 exclusive owner of a mailbox, neither in sending nor in receiving.
247 Many actors can send into and/or receive from the same mailbox. TCP
248 socket ports for example are shared on the sender side but exclusive
249 on the receiver side (only one process can receive from a given socket
250 at a given point of time).
252 A big difference with TCP sockets or MPI communications is that
253 communications do not start right away after a
254 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put()>`, but wait
255 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get()>`.
256 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
258 A big difference with twitter hashtags is that SimGrid does not
259 offer easy support to broadcast a given message to many
260 receivers. So that would be like a twitter tag where each message
261 is consumed by the first receiver.
263 A big difference with the ZeroMQ queues is that you cannot filter
264 on the data you want to get from the mailbox. To model such settings
265 in SimGrid, you'd have one mailbox per potential topic, and subscribe
266 to each topic individually with a
267 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async()>` on each mailbox.
268 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any()>`
269 to get the first message on any of the mailbox you are subscribed onto.
271 The mailboxes are not located on the network, and you can access
272 them without any latency. The network delay are only related to the
273 location of the sender and receiver once the match between them is
274 done on the mailbox. This is just like the phone number that you
275 can use locally, and the geographical distance only comes into play
276 once you start the communication by dialing this number.
278 =====================
279 How to use Mailboxes?
280 =====================
282 You can retrieve any existing mailbox from its name (which is a
283 unique string, just like a twitter tag). This results in a
284 versatile mechanism that can be used to build many different
287 To model classical socket communications, use "hostname:port" as
288 mailbox names, and make sure that only one actor reads into a given
289 mailbox. This does not make it easy to build a perfectly realistic
290 model of the TCP sockets, but in most cases, this system is too
291 cumbersome for your simulations anyway. You probably want something
292 simpler, that turns our to be easy to build with the mailboxes.
294 Many SimGrid examples use a sort of yellow page system where the
295 mailbox names are the name of the service (such as "worker",
296 "master" or "reducer"). That way, you don't have to know where your
297 peer is located to contact it. You don't even need its name. Its
298 function is enough for that. This also gives you some sort of load
299 balancing for free if more than one actor pulls from the mailbox:
300 the first actor that can deal with the request will handle it.
302 =========================================
303 How are put() and get() requests matched?
304 =========================================
306 The matching algorithm simple: first come, first serve. When a new
307 send arrives, it matches the oldest enqueued receive. If no receive is
308 currently enqueued, then the incoming send is enqueued. As you can
309 see, the mailbox cannot contain both send and receive requests: all
310 enqueued requests must be of the same sort.
312 .. _s4u_receiving_actor:
314 ===========================
315 Declaring a Receiving Actor
316 ===========================
318 The last twist is that by default in the simulator, the data starts
319 to be exchanged only when both the sender and the receiver are
320 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
321 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
322 In TCP, since you establish connections beforehand, the data starts to
323 flow as soon as the sender posts it, even if the receiver did not post
324 its :cpp:func:`recv() <simgrid::s4u::Mailbox::recv()>` yet.
326 To model this in SimGrid, you can declare a specific receiver to a
327 given mailbox (with the function
328 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
329 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
330 posted to that mailbox will start as soon as possible, and the data
331 will already be there on the receiver host when the receiver actor
332 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
334 Note that being permanent receivers of a mailbox prevents actors to be
335 garbage-collected. If your simulation creates many short-lived actors
336 that marked as permanent receiver, you should call
337 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
338 memory gets properly reclaimed. This call should be at the end of the
339 actor's function, not in a on_exit callback.
346 For sake of simplicity, we use `RAII
347 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
348 for many classes in S4U. This is an idiom where resources are automatically
349 managed through the context. Provided that you never manipulate
350 objects of type Foo directly but always FooPtr references (which are
351 defined as `boost::intrusive_ptr
352 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
353 <Foo>), you will never have to explicitly release the resource that
354 you use nor to free the memory of unused objects.
355 Here is a little example:
361 simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
363 mutex->lock(); // use the mutex as a simple reference
367 } // The mutex gets automatically freed because the only existing reference gets out of scope
369 Note that Mailboxes, Hosts and Links are not handled thought smart
370 pointers (yet?). This means that it is currently impossible to destroy a
371 mailbox or a link. You can still destroy an host (but probably
372 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
376 .. include:: ../../examples/README.rst
381 .. _API_s4u_simulation_object:
393 .. autodoxyclass:: simgrid::s4u::Actor
395 .. doxygentypedef:: ActorPtr
397 .. doxygentypedef:: aid_t
408 #include <simgrid/s4u/Engine.hpp>
410 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
411 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
412 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
413 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
415 .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
416 .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
418 .. group-tab:: Python
422 from simgrid import Actor
424 .. automethod:: simgrid.Actor.create
430 #include <simgrid/actor.h>
432 .. doxygentypedef:: sg_actor_t
433 .. cpp:type:: const s4u_Actor* const_sg_actor_t
435 Pointer to a constant actor object.
437 .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
438 .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
440 .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
441 .. autodoxymethod:: sg_actor_detach()
443 .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
444 .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
446 Searching specific actors
447 -------------------------
453 .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
454 .. autodoxymethod:: simgrid::s4u::Actor::self()
456 .. group-tab:: Python
458 .. automethod:: simgrid.Actor.by_pid
459 .. automethod:: simgrid.Actor.self
463 .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
464 .. autodoxymethod:: sg_actor_self()
466 Querying info about actors
467 --------------------------
473 .. autodoxymethod:: simgrid::s4u::Actor::get_cname
474 .. autodoxymethod:: simgrid::s4u::Actor::get_name
475 .. autodoxymethod:: simgrid::s4u::Actor::get_pid
476 .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
477 .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
478 .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
479 .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
481 .. autodoxymethod:: simgrid::s4u::Actor::get_host
482 .. autodoxymethod:: simgrid::s4u::Actor::set_host
484 .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
485 .. autodoxymethod:: simgrid::s4u::Actor::get_impl
487 .. group-tab:: Python
489 .. autoattribute:: simgrid.Actor.name
490 .. autoattribute:: simgrid.Actor.host
491 .. autoattribute:: simgrid.Actor.pid
492 .. autoattribute:: simgrid.Actor.ppid
496 .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
497 .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
498 .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
499 .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
500 .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
502 .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
503 .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
505 .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor)
506 .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata)
508 Suspending and resuming actors
509 ------------------------------
515 .. autodoxymethod:: simgrid::s4u::Actor::suspend()
516 .. autodoxymethod:: simgrid::s4u::Actor::resume()
517 .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
519 .. group-tab:: Python
521 .. automethod:: simgrid.Actor.resume
522 .. automethod:: simgrid.Actor.suspend
523 .. automethod:: simgrid.Actor.is_suspended
527 .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
528 .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
529 .. autodoxymethod:: sg_actor_is_suspended(sg_actor_t actor)
531 Specifying when actors should terminate
532 ---------------------------------------
538 .. autodoxymethod:: simgrid::s4u::Actor::kill()
539 .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
540 .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
541 .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
543 .. autodoxymethod:: simgrid::s4u::Actor::restart()
544 .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
545 .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
547 .. group-tab:: Python
549 .. automethod:: simgrid.Actor.kill
550 .. automethod:: simgrid.Actor.kill_all
552 .. automethod:: simgrid.Actor.daemonize
553 .. automethod:: simgrid.Actor.is_daemon
557 .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
558 .. autodoxymethod:: sg_actor_kill_all()
559 .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
561 .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
562 .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
564 .. _API_s4u_Actor_end:
566 Reacting to the end of actors
567 -----------------------------
573 .. autodoxymethod:: simgrid::s4u::Actor::on_exit
574 .. autodoxymethod:: simgrid::s4u::Actor::join()
575 .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
576 .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
578 .. group-tab:: Python
580 .. automethod:: simgrid.Actor.join
584 .. autodoxymethod:: sg_actor_join(sg_actor_t actor, double timeout)
585 .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
594 .. autodoxyvar:: simgrid::s4u::Actor::on_creation
595 .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
596 .. autodoxyvar:: simgrid::s4u::Actor::on_resume
597 .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
598 .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
599 .. autodoxyvar:: simgrid::s4u::Actor::on_termination
600 .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
602 .. _API_s4u_this_actor:
608 These functions can be used in your user code to interact with the actor
609 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
610 Using these functions can greatly improve the code readability.
619 .. autodoxymethod:: simgrid::s4u::this_actor::get_cname()
620 .. autodoxymethod:: simgrid::s4u::this_actor::get_name()
621 .. autodoxymethod:: simgrid::s4u::this_actor::get_pid()
622 .. autodoxymethod:: simgrid::s4u::this_actor::get_ppid()
623 .. autodoxymethod:: simgrid::s4u::this_actor::is_maestro()
625 .. autodoxymethod:: simgrid::s4u::this_actor::get_host()
626 .. autodoxymethod:: simgrid::s4u::this_actor::set_host(Host *new_host)
628 .. group-tab:: Python
630 .. autofunction:: simgrid.this_actor.get_host
631 .. autofunction:: simgrid.this_actor.set_host
635 .. autodoxymethod:: sg_actor_self_data()
636 .. autodoxymethod:: sg_actor_self_data_set(void *data)
637 .. autodoxymethod:: sg_actor_self_get_name()
638 .. autodoxymethod:: sg_actor_self_get_pid()
639 .. autodoxymethod:: sg_actor_self_get_ppid()
640 .. autodoxymethod:: sg_host_self()
641 .. autodoxymethod:: sg_host_self_get_name()
643 Suspending and resuming
644 -----------------------
650 .. autodoxymethod:: simgrid::s4u::this_actor::suspend()
651 .. autodoxymethod:: simgrid::s4u::this_actor::yield()
653 .. group-tab:: Python
655 .. autofunction:: simgrid.this_actor.suspend
656 .. autofunction:: simgrid.this_actor.yield_
663 .. group-tab:: Python
665 .. autofunction:: simgrid.this_actor.info
666 .. autofunction:: simgrid.this_actor.error
675 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(double duration)
676 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
677 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
678 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
680 .. group-tab:: Python
682 .. autofunction:: simgrid.this_actor.sleep_for
683 .. autofunction:: simgrid.this_actor.sleep_until
687 .. autodoxymethod:: sg_actor_sleep_for(double duration)
689 Simulating executions
690 ---------------------
692 Simulate the execution of some code on this actor. You can either simulate
693 parallel or sequential code, and you can either block upon the termination of
694 the execution, or start an asynchronous activity.
700 .. autodoxymethod:: simgrid::s4u::this_actor::exec_async(double flops_amounts)
701 .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
702 .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
703 .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
704 .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
705 .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
706 .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
708 .. group-tab:: Python
710 .. autofunction:: simgrid.this_actor.exec_init
711 .. autofunction:: simgrid.this_actor.execute
715 .. autodoxymethod:: sg_actor_self_execute(double flops)
724 .. autodoxymethod:: simgrid::s4u::this_actor::exit()
725 .. autodoxymethod:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
727 .. group-tab:: Python
729 .. autofunction:: simgrid.this_actor.exit
730 .. autofunction:: simgrid.this_actor.on_exit
738 .. autodoxyclass:: simgrid::s4u::Engine
747 .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
748 .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
749 .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
750 .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
752 .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
753 .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
754 .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
755 .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
756 .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
757 .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
758 .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
760 .. group-tab:: Python
762 .. automethod:: simgrid.Engine.load_deployment
763 .. automethod:: simgrid.Engine.load_platform
764 .. automethod:: simgrid.Engine.register_actor
768 .. autodoxymethod:: simgrid_init
770 .. autodoxymethod:: simgrid_load_deployment
771 .. autodoxymethod:: simgrid_load_platform
772 .. autodoxymethod:: simgrid_register_default
773 .. autodoxymethod:: simgrid_register_function
782 .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
783 .. autodoxymethod:: simgrid::s4u::Engine::run()
785 .. group-tab:: Python
787 .. automethod:: simgrid.Engine.get_clock
788 .. automethod:: simgrid.Engine.run
792 .. autodoxymethod:: simgrid_get_clock
793 .. autodoxymethod:: simgrid_run
802 .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
803 .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
804 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
808 .. autodoxymethod:: simgrid_get_actor_count()
817 .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
818 .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
819 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
820 .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
821 .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
823 .. group-tab:: Python
825 .. automethod:: simgrid.Engine.get_all_hosts
834 .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
835 .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
836 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
837 .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
838 .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
840 Interacting with the routing
841 ----------------------------
847 .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
848 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
849 .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
850 .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
851 .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
852 .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
853 .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
862 .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
863 .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
864 .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
865 .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
866 .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
874 .. autodoxyclass:: simgrid::s4u::Mailbox
876 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
887 #include <simgrid/s4u/Mailbox.hpp>
889 Note that there is no MailboxPtr type, and that you cannot use the RAII
890 idiom on mailboxes because they are internal objects to the simulation
891 engine. Once created, there is no way to destroy a mailbox before the end
894 .. autodoxymethod:: simgrid::s4u::Mailbox::by_name(const std::string &name)
896 .. group-tab:: Python
898 .. automethod:: simgrid.Mailbox.by_name
907 .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname()
908 .. autodoxymethod:: simgrid::s4u::Mailbox::get_name()
910 .. group-tab:: Python
912 .. autoattribute:: simgrid.Mailbox.name
921 .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
922 .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
923 .. autodoxymethod:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
924 .. autodoxymethod:: simgrid::s4u::Mailbox::put_init()
925 .. autodoxymethod:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
927 .. group-tab:: Python
929 .. automethod:: simgrid.Mailbox.put
930 .. automethod:: simgrid.Mailbox.put_async
940 .. autodoxymethod:: simgrid::s4u::Mailbox::empty()
941 .. autodoxymethod:: simgrid::s4u::Mailbox::front()
942 .. autodoxymethod:: simgrid::s4u::Mailbox::get()
943 .. autodoxymethod:: simgrid::s4u::Mailbox::get(double timeout)
944 .. autodoxymethod:: simgrid::s4u::Mailbox::get_async(void **data)
945 .. autodoxymethod:: simgrid::s4u::Mailbox::get_init()
946 .. autodoxymethod:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
947 .. autodoxymethod:: simgrid::s4u::Mailbox::listen()
948 .. autodoxymethod:: simgrid::s4u::Mailbox::ready()
950 .. group-tab:: Python
952 .. automethod:: simgrid.Mailbox.get
956 .. autodoxymethod:: sg_mailbox_listen(const char *alias)
961 See :ref:`s4u_receiving_actor`.
967 .. autodoxymethod:: simgrid::s4u::Mailbox::get_receiver()
968 .. autodoxymethod:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
972 .. autodoxymethod:: ::sg_mailbox_set_receiver(const char *alias)
974 .. _API_s4u_Resource:
986 .. doxygenclass:: simgrid::s4u::Disk
999 .. doxygenclass:: simgrid::s4u::Host
1010 .. doxygenclass:: simgrid::s4u::Link
1015 .. _API_s4u_NetZone:
1021 .. doxygenclass:: simgrid::s4u::NetZone
1026 .. _API_s4u_VirtualMachine:
1028 =======================
1029 class VirtualMachine
1030 =======================
1032 .. doxygenclass:: simgrid::s4u::VirtualMachine
1037 .. autodoxymethod:: sg_vm_create_core
1038 .. autodoxymethod:: sg_vm_create_multicore
1039 .. autodoxymethod:: sg_vm_get_name
1040 .. autodoxymethod:: sg_vm_get_pm
1041 .. autodoxymethod:: sg_vm_is_created
1042 .. autodoxymethod:: sg_vm_is_running
1043 .. autodoxymethod:: sg_vm_is_suspended
1044 .. autodoxymethod:: sg_vm_start
1045 .. autodoxymethod:: sg_vm_suspend
1046 .. autodoxymethod:: sg_vm_resume
1047 .. autodoxymethod:: sg_vm_shutdown
1048 .. autodoxymethod:: sg_vm_destroy
1050 .. _API_s4u_Activity:
1056 .. autodoxyclass:: simgrid::s4u::Activity
1058 **Known subclasses:**
1059 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1060 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1061 :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1062 See also the :ref:`section on activities <s4u_Activities>` above.
1064 Querying info about activities
1065 ------------------------------
1067 .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
1068 .. autodoxymethod:: simgrid::s4u::Activity::get_state()
1069 .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
1070 .. autodoxymethod:: simgrid::s4u::Activity::get_impl
1072 Activities lifecycle
1073 --------------------
1075 .. autodoxymethod:: simgrid::s4u::Activity::start
1076 .. autodoxymethod:: simgrid::s4u::Activity::cancel
1077 .. autodoxymethod:: simgrid::s4u::Activity::test
1078 .. autodoxymethod:: simgrid::s4u::Activity::wait
1079 .. autodoxymethod:: simgrid::s4u::Activity::wait_for
1080 .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
1088 .. doxygentypedef:: CommPtr
1090 .. doxygenclass:: simgrid::s4u::Comm
1101 .. doxygentypedef:: ExecPtr
1103 .. doxygenclass:: simgrid::s4u::Exec
1108 .. _API_s4u_ExecSeq:
1114 .. doxygentypedef:: ExecSeqPtr
1116 .. doxygenclass:: simgrid::s4u::ExecSeq
1121 .. _API_s4u_ExecPar:
1127 .. doxygentypedef:: ExecParPtr
1129 .. doxygenclass:: simgrid::s4u::ExecPar
1140 .. doxygentypedef:: IoPtr
1142 .. doxygenclass:: simgrid::s4u::Io
1147 .. _API_s4u_Synchronizations:
1149 =======================
1150 Synchronization Objects
1151 =======================
1159 .. autodoxyclass:: simgrid::s4u::Mutex
1170 #include <simgrid/s4u/Mutex.hpp>
1172 .. doxygentypedef:: MutexPtr
1174 .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
1175 .. autodoxymethod:: simgrid::s4u::Mutex::create()
1176 .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
1182 #include <simgrid/mutex.h>
1184 .. doxygentypedef:: sg_mutex_t
1185 .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
1187 Pointer to a constant mutex object.
1189 .. autodoxymethod:: sg_mutex_init()
1190 .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
1199 .. autodoxymethod:: simgrid::s4u::Mutex::lock()
1200 .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
1201 .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
1205 .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
1206 .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
1207 .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
1209 .. _API_s4u_Barrier:
1215 .. autodoxyclass:: simgrid::s4u::Barrier
1223 #include <simgrid/s4u/Barrier.hpp>
1225 .. doxygentypedef:: BarrierPtr
1227 .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
1228 .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
1229 .. autodoxymethod:: simgrid::s4u::Barrier::wait()
1235 #include <simgrid/barrier.hpp>
1237 .. doxygentypedef:: sg_bar_t
1238 .. cpp:type:: const s4u_Barrier* const_sg_bar_t
1240 Pointer to a constant barrier object.
1242 .. autodoxymethod:: sg_barrier_init(unsigned int count)
1243 .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
1244 .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
1247 .. _API_s4u_ConditionVariable:
1249 ==========================
1250 Condition variable
1251 ==========================
1253 .. autodoxyclass:: simgrid::s4u::ConditionVariable
1264 #include <simgrid/s4u/ConditionVariable.hpp>
1266 .. doxygentypedef:: ConditionVariablePtr
1268 .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
1274 #include <simgrid/cond.h>
1276 .. doxygentypedef:: sg_cond_t
1277 .. doxygenfunction:: sg_cond_init
1278 .. doxygenfunction:: sg_cond_destroy
1280 Waiting and notifying
1281 ---------------------
1287 .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
1288 .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
1289 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
1290 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
1291 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
1292 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
1293 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
1294 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
1295 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
1296 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
1297 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
1298 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
1299 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
1303 .. doxygenfunction:: sg_cond_notify_all
1304 .. doxygenfunction:: sg_cond_notify_one
1305 .. doxygenfunction:: sg_cond_wait
1306 .. doxygenfunction:: sg_cond_wait_for
1308 .. _API_s4u_Semaphore:
1314 .. autodoxyclass:: simgrid::s4u::Semaphore
1326 #include <simgrid/s4u/Semaphore.hpp>
1328 .. doxygentypedef:: SemaphorePtr
1329 .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
1330 .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
1331 .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
1337 #include <simgrid/semaphore.h>
1339 .. doxygentypedef:: sg_sem_t
1340 .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
1342 Pointer to a constant semaphore object.
1344 .. autodoxymethod:: sg_sem_init(int initial_value)
1345 .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
1354 .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
1355 .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
1356 .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity()
1357 .. autodoxymethod:: simgrid::s4u::Semaphore::release()
1358 .. autodoxymethod:: simgrid::s4u::Semaphore::would_block()
1362 .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
1363 .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
1364 .. autodoxymethod:: sg_sem_get_capacity(sg_sem_t sem)
1365 .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
1366 .. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)
1368 Python API Reference
1369 ********************
1371 The Python API is automatically generated with pybind11. It closely mimicks the C++
1372 API, to which you should refer for more information.
1378 .. automodule:: simgrid.this_actor
1385 .. autoclass:: simgrid.Comm
1392 .. autoclass:: simgrid.Exec
1399 .. autoclass:: simgrid.Host
1406 .. autoclass:: simgrid.Mailbox