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>`.
172 Every kind of activity can be asynchronous:
174 - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
175 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
176 :cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`.
177 - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
178 :cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
179 :cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`.
180 - :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
181 :cpp:func:`s4u::Host::exec_async() <simgrid::s4u::Host::exec_async>`.
182 - In the future, it will become possible to have asynchronous IPC
183 such as asynchronous mutex lock requests.
185 The following example shows how to have several concurrent
186 communications ongoing. First, you have to declare a vector in which
187 we will store the ongoing communications. It is also useful to have a
190 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
192 :start-after: init-begin
193 :end-before: init-end
196 Then, you start all the communications that should occur concurrently with
197 :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
198 Finally, the actor waits for the completion of all of them at once
200 :cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
202 .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
204 :start-after: put-begin
209 =====================
210 Activities Life cycle
211 =====================
213 Sometimes, you want to change the setting of an activity before it even starts.
215 .. todo:: write this section
222 Please also refer to the :ref:`API reference for s4u::Mailbox
229 |API_s4u_Mailboxes|_ are rendez-vous points for network communications,
230 similar to URLs on which you could post and retrieve data. Actually,
231 the mailboxes are not involved in the communication once it starts,
232 but only to find the contact with which you want to communicate.
234 They are similar to many common things: The phone number, which allows
235 the caller to find the receiver. The twitter hashtag, which help
236 senders and receivers to find each others. In TCP, the pair
237 ``{host name, host port}`` to which you can connect to find your peer.
238 In HTTP, URLs through which the clients can connect to the servers.
239 In ZeroMQ, the queues are used to match senders and receivers.
241 One big difference with most of these systems is that no actor is the
242 exclusive owner of a mailbox, neither in sending nor in receiving.
243 Many actors can send into and/or receive from the same mailbox. TCP
244 socket ports for example are shared on the sender side but exclusive
245 on the receiver side (only one process can receive from a given socket
246 at a given point of time).
248 A big difference with TCP sockets or MPI communications is that
249 communications do not start right away after a
250 :cpp:func:`Mailbox::put() <simgrid::s4u::Mailbox::put()>`, but wait
251 for the corresponding :cpp:func:`Mailbox::get() <simgrid::s4u::Mailbox::get()>`.
252 You can change this by :ref:`declaring a receiving actor <s4u_receiving_actor>`.
254 A big difference with twitter hashtags is that SimGrid does not
255 offer easy support to broadcast a given message to many
256 receivers. So that would be like a twitter tag where each message
257 is consumed by the first receiver.
259 A big difference with the ZeroMQ queues is that you cannot filter
260 on the data you want to get from the mailbox. To model such settings
261 in SimGrid, you'd have one mailbox per potential topic, and subscribe
262 to each topic individually with a
263 :cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async()>` on each mailbox.
264 Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any()>`
265 to get the first message on any of the mailbox you are subscribed onto.
267 The mailboxes are not located on the network, and you can access
268 them without any latency. The network delay are only related to the
269 location of the sender and receiver once the match between them is
270 done on the mailbox. This is just like the phone number that you
271 can use locally, and the geographical distance only comes into play
272 once you start the communication by dialing this number.
274 =====================
275 How to use Mailboxes?
276 =====================
278 You can retrieve any existing mailbox from its name (which is a
279 unique string, just like a twitter tag). This results in a
280 versatile mechanism that can be used to build many different
283 To model classical socket communications, use "hostname:port" as
284 mailbox names, and make sure that only one actor reads into a given
285 mailbox. This does not make it easy to build a perfectly realistic
286 model of the TCP sockets, but in most cases, this system is too
287 cumbersome for your simulations anyway. You probably want something
288 simpler, that turns our to be easy to build with the mailboxes.
290 Many SimGrid examples use a sort of yellow page system where the
291 mailbox names are the name of the service (such as "worker",
292 "master" or "reducer"). That way, you don't have to know where your
293 peer is located to contact it. You don't even need its name. Its
294 function is enough for that. This also gives you some sort of load
295 balancing for free if more than one actor pulls from the mailbox:
296 the first actor that can deal with the request will handle it.
298 =========================================
299 How are put() and get() requests matched?
300 =========================================
302 The matching algorithm simple: first come, first serve. When a new
303 send arrives, it matches the oldest enqueued receive. If no receive is
304 currently enqueued, then the incoming send is enqueued. As you can
305 see, the mailbox cannot contain both send and receive requests: all
306 enqueued requests must be of the same sort.
308 .. _s4u_receiving_actor:
310 ===========================
311 Declaring a Receiving Actor
312 ===========================
314 The last twist is that by default in the simulator, the data starts
315 to be exchanged only when both the sender and the receiver are
316 announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
317 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
318 In TCP, since you establish connections beforehand, the data starts to
319 flow as soon as the sender posts it, even if the receiver did not post
320 its :cpp:func:`recv() <simgrid::s4u::Mailbox::recv()>` yet.
322 To model this in SimGrid, you can declare a specific receiver to a
323 given mailbox (with the function
324 :cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
325 That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
326 posted to that mailbox will start as soon as possible, and the data
327 will already be there on the receiver host when the receiver actor
328 posts its :cpp:func:`get() <simgrid::s4u::Mailbox::get()>`
330 Note that being permanent receivers of a mailbox prevents actors to be
331 garbage-collected. If your simulation creates many short-lived actors
332 that marked as permanent receiver, you should call
333 ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their
334 memory gets properly reclaimed. This call should be at the end of the
335 actor's function, not in a on_exit callback.
342 For sake of simplicity, we use `RAII
343 <https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_
344 for many classes in S4U. This is an idiom where resources are automatically
345 managed through the context. Provided that you never manipulate
346 objects of type Foo directly but always FooPtr references (which are
347 defined as `boost::intrusive_ptr
348 <http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html>`_
349 <Foo>), you will never have to explicitly release the resource that
350 you use nor to free the memory of unused objects.
351 Here is a little example:
357 simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
359 mutex->lock(); // use the mutex as a simple reference
363 } // The mutex gets automatically freed because the only existing reference gets out of scope
365 Note that Mailboxes, Hosts and Links are not handled thought smart
366 pointers (yet?). This means that it is currently impossible to destroy a
367 mailbox or a link. You can still destroy an host (but probably
368 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
372 .. include:: ../../examples/README.rst
377 .. _API_s4u_simulation_object:
389 .. autodoxyclass:: simgrid::s4u::Actor
391 .. doxygentypedef:: aid_t
402 #include <simgrid/s4u/Actor.hpp>
404 .. doxygentypedef:: ActorPtr
406 .. group-tab:: Python
410 from simgrid import Actor
416 #include <simgrid/actor.h>
418 .. doxygentypedef:: sg_actor_t
419 .. cpp:type:: const s4u_Actor* const_sg_actor_t
421 Pointer to a constant actor object.
423 .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
424 .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
433 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
434 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
435 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
436 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
438 .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
439 .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
441 .. group-tab:: Python
443 .. automethod:: simgrid.Actor.create
447 .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
448 .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char *const *argv)
450 .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
451 .. autodoxymethod:: sg_actor_detach()
460 .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
461 .. autodoxymethod:: simgrid::s4u::Actor::self()
463 .. group-tab:: Python
465 .. automethod:: simgrid.Actor.by_pid
466 .. automethod:: simgrid.Actor.self
470 .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
471 .. autodoxymethod:: sg_actor_self()
480 .. autodoxymethod:: simgrid::s4u::Actor::get_cname
481 .. autodoxymethod:: simgrid::s4u::Actor::get_name
482 .. autodoxymethod:: simgrid::s4u::Actor::get_pid
483 .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
484 .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
485 .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
486 .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
488 .. autodoxymethod:: simgrid::s4u::Actor::get_host
489 .. autodoxymethod:: simgrid::s4u::Actor::set_host
491 .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
492 .. autodoxymethod:: simgrid::s4u::Actor::get_impl
494 .. group-tab:: Python
496 .. autoattribute:: simgrid.Actor.name
497 .. autoattribute:: simgrid.Actor.host
498 .. autoattribute:: simgrid.Actor.pid
499 .. autoattribute:: simgrid.Actor.ppid
503 .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
504 .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
505 .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
506 .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
507 .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
509 .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
510 .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
512 .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor)
513 .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata)
515 Suspending and resuming actors
516 ------------------------------
522 .. autodoxymethod:: simgrid::s4u::Actor::suspend()
523 .. autodoxymethod:: simgrid::s4u::Actor::resume()
524 .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
526 .. group-tab:: Python
528 .. automethod:: simgrid.Actor.resume
529 .. automethod:: simgrid.Actor.suspend
530 .. automethod:: simgrid.Actor.is_suspended
534 .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
535 .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
536 .. autodoxymethod:: sg_actor_is_suspended(sg_actor_t actor)
538 Specifying when actors should terminate
539 ---------------------------------------
545 .. autodoxymethod:: simgrid::s4u::Actor::kill()
546 .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
547 .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
548 .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
550 .. autodoxymethod:: simgrid::s4u::Actor::restart()
551 .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
552 .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
554 .. group-tab:: Python
556 .. automethod:: simgrid.Actor.kill
557 .. automethod:: simgrid.Actor.kill_all
559 .. automethod:: simgrid.Actor.daemonize
560 .. automethod:: simgrid.Actor.is_daemon
564 .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
565 .. autodoxymethod:: sg_actor_kill_all()
566 .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
568 .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
569 .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
570 .. autodoxymethod:: sg_actor_is_daemon
572 .. _API_s4u_Actor_end:
574 Reacting to the end of actors
575 -----------------------------
581 .. autodoxymethod:: simgrid::s4u::Actor::on_exit
582 .. autodoxymethod:: simgrid::s4u::Actor::join()
583 .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
584 .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
586 .. group-tab:: Python
588 .. automethod:: simgrid.Actor.join
592 .. autodoxymethod:: sg_actor_join(sg_actor_t actor, double timeout)
593 .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
602 .. autodoxyvar:: simgrid::s4u::Actor::on_creation
603 .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
604 .. cpp:var:: xbt::signal<void(const Actor&, const Host & previous_location)> Actor::on_host_change
606 Signal fired when an actor is migrated from one host to another.
608 .. autodoxyvar:: simgrid::s4u::Actor::on_resume
609 .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
610 .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
611 .. autodoxyvar:: simgrid::s4u::Actor::on_termination
612 .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
614 .. _API_s4u_this_actor:
620 These functions can be used in your user code to interact with the actor
621 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
622 Using these functions can greatly improve the code readability.
631 .. autodoxymethod:: simgrid::s4u::this_actor::get_cname()
632 .. autodoxymethod:: simgrid::s4u::this_actor::get_name()
633 .. autodoxymethod:: simgrid::s4u::this_actor::get_pid()
634 .. autodoxymethod:: simgrid::s4u::this_actor::get_ppid()
635 .. autodoxymethod:: simgrid::s4u::this_actor::is_maestro()
637 .. autodoxymethod:: simgrid::s4u::this_actor::get_host()
638 .. autodoxymethod:: simgrid::s4u::this_actor::set_host(Host *new_host)
640 .. group-tab:: Python
642 .. autofunction:: simgrid.this_actor.get_host
643 .. autofunction:: simgrid.this_actor.set_host
647 .. autodoxymethod:: sg_actor_self_data()
648 .. autodoxymethod:: sg_actor_self_data_set(void *data)
649 .. autodoxymethod:: sg_actor_self_get_name()
650 .. autodoxymethod:: sg_actor_self_get_pid()
651 .. autodoxymethod:: sg_actor_self_get_ppid()
652 .. autodoxymethod:: sg_host_self()
653 .. autodoxymethod:: sg_host_self_get_name()
655 Suspending and resuming
656 -----------------------
662 .. autodoxymethod:: simgrid::s4u::this_actor::suspend()
663 .. autodoxymethod:: simgrid::s4u::this_actor::yield()
665 .. group-tab:: Python
667 .. autofunction:: simgrid.this_actor.suspend
668 .. autofunction:: simgrid.this_actor.yield_
675 .. group-tab:: Python
677 .. autofunction:: simgrid.this_actor.info
678 .. autofunction:: simgrid.this_actor.error
687 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(double duration)
688 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
689 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
690 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
692 .. group-tab:: Python
694 .. autofunction:: simgrid.this_actor.sleep_for
695 .. autofunction:: simgrid.this_actor.sleep_until
699 .. autodoxymethod:: sg_actor_sleep_for(double duration)
701 Simulating executions
702 ---------------------
704 Simulate the execution of some code on this actor. You can either simulate
705 parallel or sequential code, and you can either block upon the termination of
706 the execution, or start an asynchronous activity.
712 .. autodoxymethod:: simgrid::s4u::this_actor::exec_async(double flops_amounts)
713 .. 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)
714 .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
715 .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
716 .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
717 .. 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)
718 .. 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)
720 .. group-tab:: Python
722 .. autofunction:: simgrid.this_actor.exec_init
723 .. autofunction:: simgrid.this_actor.execute
727 .. autodoxymethod:: sg_actor_self_execute(double flops)
736 .. autodoxymethod:: simgrid::s4u::this_actor::exit()
737 .. autodoxymethod:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
739 .. group-tab:: Python
741 .. autofunction:: simgrid.this_actor.exit
742 .. autofunction:: simgrid.this_actor.on_exit
750 .. autodoxyclass:: simgrid::s4u::Engine
759 .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
760 .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
761 .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
762 .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
763 .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
764 .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
765 .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, int value)
766 .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, std::string value)
768 .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
769 .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
770 .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
771 .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
772 .. autodoxymethod:: simgrid::s4u::Engine::register_default(void(*code)(int, char **))
773 .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
774 .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(int, char **))
776 .. group-tab:: Python
778 .. automethod:: simgrid.Engine.load_deployment
779 .. automethod:: simgrid.Engine.load_platform
780 .. automethod:: simgrid.Engine.register_actor
784 .. autodoxymethod:: simgrid_init
786 .. autodoxymethod:: simgrid_load_deployment
787 .. autodoxymethod:: simgrid_load_platform
788 .. autodoxymethod:: simgrid_register_default
789 .. autodoxymethod:: simgrid_register_function
798 .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
799 .. autodoxymethod:: simgrid::s4u::Engine::run()
801 .. group-tab:: Python
803 .. automethod:: simgrid.Engine.get_clock
804 .. automethod:: simgrid.Engine.run
808 .. autodoxymethod:: simgrid_get_clock
809 .. autodoxymethod:: simgrid_run
818 .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
819 .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
820 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
824 .. autodoxymethod:: simgrid_get_actor_count()
833 .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
834 .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
835 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
836 .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
837 .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
839 .. group-tab:: Python
841 .. automethod:: simgrid.Engine.get_all_hosts
845 See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
854 .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
855 .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
856 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
857 .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
858 .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
860 Interacting with the routing
861 ----------------------------
867 .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
868 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
869 .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
870 .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
871 .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
872 .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
873 .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
882 .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
883 .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
884 .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
885 .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
886 .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
894 .. autodoxyclass:: simgrid::s4u::Mailbox
896 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
907 #include <simgrid/s4u/Mailbox.hpp>
909 Note that there is no MailboxPtr type, and that you cannot use the RAII
910 idiom on mailboxes because they are internal objects to the simulation
911 engine. Once created, there is no way to destroy a mailbox before the end
914 .. autodoxymethod:: simgrid::s4u::Mailbox::by_name(const std::string &name)
916 .. group-tab:: Python
918 .. automethod:: simgrid.Mailbox.by_name
927 .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname() const
928 .. autodoxymethod:: simgrid::s4u::Mailbox::get_name() const
930 .. group-tab:: Python
932 .. autoattribute:: simgrid.Mailbox.name
941 .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
942 .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
943 .. autodoxymethod:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
944 .. autodoxymethod:: simgrid::s4u::Mailbox::put_init()
945 .. autodoxymethod:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
947 .. group-tab:: Python
949 .. automethod:: simgrid.Mailbox.put
950 .. automethod:: simgrid.Mailbox.put_async
960 .. autodoxymethod:: simgrid::s4u::Mailbox::empty()
961 .. autodoxymethod:: simgrid::s4u::Mailbox::front()
962 .. autodoxymethod:: simgrid::s4u::Mailbox::get()
963 .. autodoxymethod:: simgrid::s4u::Mailbox::get(double timeout)
964 .. autodoxymethod:: simgrid::s4u::Mailbox::get_async(void **data)
965 .. autodoxymethod:: simgrid::s4u::Mailbox::get_init()
966 .. autodoxymethod:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
967 .. autodoxymethod:: simgrid::s4u::Mailbox::listen()
968 .. autodoxymethod:: simgrid::s4u::Mailbox::ready()
970 .. group-tab:: Python
972 .. automethod:: simgrid.Mailbox.get
976 .. autodoxymethod:: sg_mailbox_listen(const char *alias)
981 See :ref:`s4u_receiving_actor`.
987 .. autodoxymethod:: simgrid::s4u::Mailbox::get_receiver()
988 .. autodoxymethod:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
992 .. autodoxymethod:: sg_mailbox_set_receiver(const char *alias)
994 .. _API_s4u_Resource:
1006 .. autodoxyclass:: simgrid::s4u::Disk
1017 #include <simgrid/s4u/Disk.hpp>
1019 Note that there is no DiskPtr type, and that you cannot use the RAII
1020 idiom on disks because SimGrid does not allow (yet) to create nor
1021 destroy resources once the simulation is started.
1031 .. autodoxymethod:: simgrid::s4u::Disk::get_cname() const
1032 .. autodoxymethod:: simgrid::s4u::Disk::get_host() const
1033 .. autodoxymethod:: simgrid::s4u::Disk::get_name() const
1034 .. autodoxymethod:: simgrid::s4u::Disk::get_properties() const
1035 .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key) const
1036 .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth() const
1037 .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth() const
1038 .. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1047 .. autodoxymethod:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type)
1048 .. autodoxymethod:: simgrid::s4u::Disk::read(sg_size_t size)
1049 .. autodoxymethod:: simgrid::s4u::Disk::read_async(sg_size_t size)
1050 .. autodoxymethod:: simgrid::s4u::Disk::write(sg_size_t size)
1051 .. autodoxymethod:: simgrid::s4u::Disk::write_async(sg_size_t size)
1060 .. autodoxyvar:: simgrid::s4u::Disk::on_creation
1061 .. autodoxyvar:: simgrid::s4u::Disk::on_destruction
1062 .. autodoxyvar:: simgrid::s4u::Disk::on_state_change
1071 .. autodoxyclass:: simgrid::s4u::Host
1082 #include <simgrid/s4u/Host.hpp>
1084 Note that there is no HostPtr type, and that you cannot use the RAII
1085 idiom on hosts because SimGrid does not allow (yet) to create nor
1086 destroy resources once the simulation is started.
1088 .. autodoxymethod:: simgrid::s4u::Host::destroy()
1090 .. group-tab:: Python
1094 from simgrid import Host
1100 #include <simgrid/host.h>
1102 .. doxygentypedef:: sg_host_t
1103 .. cpp:type:: const s4u_Host* const_sg_host_t
1105 Pointer to a constant host object.
1114 See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1116 .. autodoxymethod:: simgrid::s4u::Host::by_name(const std::string &name)
1117 .. autodoxymethod:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1118 .. autodoxymethod:: simgrid::s4u::Host::current()
1120 .. group-tab:: Python
1122 See also :py:func:`simgrid.Engine.get_all_hosts`.
1124 .. automethod:: simgrid.Host.by_name
1125 .. automethod:: simgrid.Host.current
1129 .. autodoxymethod:: sg_host_by_name(const char *name)
1130 .. autodoxymethod:: sg_host_count()
1131 .. autodoxymethod:: sg_host_list()
1132 .. autodoxymethod:: sg_hosts_as_dynar()
1141 .. autodoxymethod:: simgrid::s4u::Host::get_cname() const
1142 .. autodoxymethod:: simgrid::s4u::Host::get_core_count() const
1143 .. autodoxymethod:: simgrid::s4u::Host::get_name() const
1144 .. autodoxymethod:: simgrid::s4u::Host::get_available_speed() const
1145 .. autodoxymethod:: simgrid::s4u::Host::get_load() const
1146 .. autodoxymethod:: simgrid::s4u::Host::get_speed() const
1148 .. group-tab:: Python
1150 .. autoattribute:: simgrid.Host.name
1151 .. autoattribute:: simgrid.Host.load
1152 .. autoattribute:: simgrid.Host.pstate
1153 .. autoattribute:: simgrid.Host.speed
1157 .. autodoxymethod:: sg_host_core_count(const_sg_host_t host)
1158 .. autodoxymethod:: sg_host_dump(const_sg_host_t ws)
1159 .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
1160 .. autodoxymethod:: sg_host_load(const_sg_host_t host)
1161 .. autodoxymethod:: sg_host_speed(const_sg_host_t host)
1163 User data and properties
1164 ------------------------
1170 .. autodoxymethod:: simgrid::s4u::Host::get_properties() const
1171 .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key) const
1172 .. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::map< std::string, std::string > &properties)
1173 .. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1177 .. autodoxymethod:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1178 .. autodoxymethod:: sg_host_get_properties(const_sg_host_t host)
1179 .. autodoxymethod:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1180 .. autodoxymethod:: sg_host_extension_create(void(*deleter)(void *))
1181 .. autodoxymethod:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1183 Retrieving components
1184 ---------------------
1190 .. autodoxymethod:: simgrid::s4u::Host::add_disk(Disk *disk)
1191 .. autodoxymethod:: simgrid::s4u::Host::get_actor_count() const
1192 .. autodoxymethod:: simgrid::s4u::Host::get_all_actors() const
1193 .. autodoxymethod:: simgrid::s4u::Host::get_disks() const
1194 .. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1198 .. autodoxymethod:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1207 .. autodoxymethod:: simgrid::s4u::Host::is_on() const
1208 .. autodoxymethod:: simgrid::s4u::Host::turn_off()
1209 .. autodoxymethod:: simgrid::s4u::Host::turn_on()
1213 .. autodoxymethod:: sg_host_is_on(const_sg_host_t host)
1214 .. autodoxymethod:: sg_host_turn_off(sg_host_t host)
1215 .. autodoxymethod:: sg_host_turn_on(sg_host_t host)
1224 .. autodoxymethod:: simgrid::s4u::Host::get_pstate() const
1225 .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count() const
1226 .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
1227 .. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
1228 .. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1229 .. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1231 .. group-tab:: Python
1233 .. automethod:: simgrid.Host.get_pstate_count
1234 .. automethod:: simgrid.Host.get_pstate_speed
1238 .. autodoxymethod:: sg_host_get_available_speed(const_sg_host_t host)
1239 .. autodoxymethod:: sg_host_get_nb_pstates(const_sg_host_t host)
1240 .. autodoxymethod:: sg_host_get_pstate(const_sg_host_t host)
1241 .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1242 .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
1251 .. autodoxymethod:: simgrid::s4u::Host::exec_async(double flops_amounts)
1252 .. autodoxymethod:: simgrid::s4u::Host::execute(double flops)
1253 .. autodoxymethod:: simgrid::s4u::Host::execute(double flops, double priority)
1255 Platform and routing
1256 --------------------
1262 .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
1263 .. autodoxymethod:: simgrid::s4u::Host::get_netpoint() const
1264 .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link *> &links, double *latency) const
1265 .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl *> &links, double *latency) const
1266 .. autodoxymethod:: simgrid::s4u::Host::sendto(Host *dest, double byte_amount)
1267 .. autodoxymethod:: simgrid::s4u::Host::sendto_async(Host *dest, double byte_amount)
1271 .. autodoxymethod:: sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1272 .. autodoxymethod:: sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1273 .. autodoxymethod:: sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
1274 .. autodoxymethod:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
1283 .. autodoxyvar:: simgrid::s4u::Host::on_creation
1284 .. autodoxyvar:: simgrid::s4u::Host::on_destruction
1285 .. autodoxyvar:: simgrid::s4u::Host::on_speed_change
1286 .. autodoxyvar:: simgrid::s4u::Host::on_state_change
1294 .. autodoxyclass:: simgrid::s4u::Link
1305 #include <simgrid/s4u/Link.hpp>
1307 Note that there is no LinkPtr type, and that you cannot use the RAII
1308 idiom on hosts because SimGrid does not allow (yet) to create nor
1309 destroy resources once the simulation is started.
1311 .. group-tab:: Python
1315 from simgrid import Link
1321 #include <simgrid/link.h>
1323 .. doxygentypedef:: sg_link_t
1324 .. cpp:type:: const s4u_Link* const_sg_link_t
1326 Pointer to a constant link object.
1335 See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1337 .. autodoxymethod:: simgrid::s4u::Link::by_name(const std::string &name)
1338 .. autodoxymethod:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1342 .. autodoxymethod:: sg_link_by_name(const char *name)
1343 .. autodoxymethod:: sg_link_count()
1344 .. autodoxymethod:: sg_link_list()
1353 .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth() const
1354 .. autodoxymethod:: simgrid::s4u::Link::get_cname() const
1355 .. autodoxymethod:: simgrid::s4u::Link::get_latency() const
1356 .. autodoxymethod:: simgrid::s4u::Link::get_name() const
1357 .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy() const
1358 .. autodoxymethod:: simgrid::s4u::Link::get_usage() const
1359 .. autodoxymethod:: simgrid::s4u::Link::is_used() const
1363 .. autodoxymethod:: sg_link_bandwidth(const_sg_link_t link)
1364 .. autodoxymethod:: sg_link_is_shared(const_sg_link_t link)
1365 .. autodoxymethod:: sg_link_latency(const_sg_link_t link)
1366 .. autodoxymethod:: sg_link_name(const_sg_link_t link)
1368 User data and properties
1369 ------------------------
1375 .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key) const
1376 .. autodoxymethod:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1380 .. autodoxymethod:: sg_link_data(const_sg_link_t link)
1381 .. autodoxymethod:: sg_link_data_set(sg_link_t link, void *data)
1390 See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1392 .. autodoxymethod:: simgrid::s4u::Link::is_on() const
1393 .. autodoxymethod:: simgrid::s4u::Link::turn_off()
1394 .. autodoxymethod:: simgrid::s4u::Link::turn_on()
1403 .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1404 .. autodoxymethod:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1405 .. autodoxymethod:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1414 .. autodoxymethod:: simgrid::s4u::Link::set_host_wifi_rate(s4u::Host* host, int level)
1423 .. autodoxyvar:: simgrid::s4u::Link::on_bandwidth_change
1424 .. cpp:var:: xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> Link::on_communicate
1425 .. autodoxyvar:: simgrid::s4u::Link::on_communication_state_change
1426 .. autodoxyvar:: simgrid::s4u::Link::on_creation
1427 .. autodoxyvar:: simgrid::s4u::Link::on_destruction
1428 .. autodoxyvar:: simgrid::s4u::Link::on_state_change
1430 .. _API_s4u_NetZone:
1436 .. autodoxyclass:: simgrid::s4u::NetZone
1447 #include <simgrid/s4u/NetZone.hpp>
1449 Note that there is no NetZonePtr type, and that you cannot use the RAII
1450 idiom on network zones because SimGrid does not allow (yet) to create nor
1451 destroy resources once the simulation is started.
1457 #include <simgrid/zone.h>
1459 .. doxygentypedef:: sg_netzone_t
1460 .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1462 Pointer to a constant network zone object.
1471 See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1472 :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1473 :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1477 .. autodoxymethod:: sg_zone_get_by_name(const char *name)
1478 .. autodoxymethod:: sg_zone_get_root()
1487 .. autodoxymethod:: simgrid::s4u::NetZone::get_cname() const
1488 .. autodoxymethod:: simgrid::s4u::NetZone::get_name() const
1492 .. autodoxymethod:: sg_zone_get_name(const_sg_netzone_t zone)
1494 User data and properties
1495 ------------------------
1501 .. autodoxymethod:: simgrid::s4u::NetZone::get_properties() const
1502 .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key) const
1503 .. autodoxymethod:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1507 .. autodoxymethod:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1508 .. autodoxymethod:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1510 Retrieving components
1511 ---------------------
1517 .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts() const
1518 .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count() const
1522 .. autodoxymethod:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1531 .. autodoxymethod:: simgrid::s4u::NetZone::add_bypass_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
1532 .. autodoxymethod:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1533 .. autodoxymethod:: simgrid::s4u::NetZone::add_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
1534 .. autodoxymethod:: simgrid::s4u::NetZone::get_children() const
1535 .. autodoxymethod:: simgrid::s4u::NetZone::get_father()
1539 .. autodoxymethod:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1548 .. autodoxyvar:: simgrid::s4u::NetZone::on_creation
1549 .. autodoxyvar:: simgrid::s4u::NetZone::on_route_creation
1550 .. autodoxyvar:: simgrid::s4u::NetZone::on_seal
1552 .. _API_s4u_VirtualMachine:
1554 =======================
1555 class VirtualMachine
1556 =======================
1559 .. autodoxyclass:: simgrid::s4u::VirtualMachine
1569 #include <simgrid/s4u/VirtualMachine.hpp>
1571 Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1572 idiom on virtual machines. There is no good reason for that and should change in the future.
1578 #include <simgrid/vm.h>
1580 .. doxygentypedef:: sg_vm_t
1581 .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1583 Pointer to a constant virtual machine object.
1592 .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1593 .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1594 .. autodoxymethod:: simgrid::s4u::VirtualMachine::destroy
1598 .. autodoxymethod:: sg_vm_create_core
1599 .. autodoxymethod:: sg_vm_create_multicore
1600 .. autodoxymethod:: sg_vm_destroy
1609 .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_pm() const
1610 .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_ramsize() const
1611 .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_state()
1613 .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1614 .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1615 .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1619 .. autodoxymethod:: sg_vm_get_ramsize(const_sg_vm_t vm)
1620 .. autodoxymethod:: sg_vm_set_bound(sg_vm_t vm, double bound)
1621 .. autodoxymethod:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1623 .. autodoxymethod:: sg_vm_get_name
1624 .. autodoxymethod:: sg_vm_get_pm
1625 .. autodoxymethod:: sg_vm_is_created
1626 .. autodoxymethod:: sg_vm_is_running
1627 .. autodoxymethod:: sg_vm_is_suspended
1636 .. autodoxymethod:: simgrid::s4u::VirtualMachine::resume()
1637 .. autodoxymethod:: simgrid::s4u::VirtualMachine::shutdown()
1638 .. autodoxymethod:: simgrid::s4u::VirtualMachine::start()
1639 .. autodoxymethod:: simgrid::s4u::VirtualMachine::suspend()
1643 .. autodoxymethod:: sg_vm_start
1644 .. autodoxymethod:: sg_vm_suspend
1645 .. autodoxymethod:: sg_vm_resume
1646 .. autodoxymethod:: sg_vm_shutdown
1655 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_end
1656 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_start
1657 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_resume
1658 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_shutdown
1659 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_start
1660 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_started
1661 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_suspend
1663 .. _API_s4u_Activity:
1669 .. autodoxyclass:: simgrid::s4u::Activity
1671 **Known subclasses:**
1672 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1673 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1674 :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1675 See also the :ref:`section on activities <s4u_Activities>` above.
1686 #include <simgrid/s4u/Activity.hpp>
1688 .. doxygentypedef:: ActivityPtr
1697 .. autodoxymethod:: simgrid::s4u::Activity::get_cname
1698 .. autodoxymethod:: simgrid::s4u::Activity::get_name
1699 .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() const
1700 .. autodoxymethod:: simgrid::s4u::Activity::get_state() const
1701 .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
1702 .. autodoxymethod:: simgrid::s4u::Activity::set_state(Activity::State state)
1705 Activities life cycle
1706 ---------------------
1712 .. autodoxymethod:: simgrid::s4u::Activity::start
1713 .. autodoxymethod:: simgrid::s4u::Activity::cancel
1714 .. autodoxymethod:: simgrid::s4u::Activity::test
1715 .. autodoxymethod:: simgrid::s4u::Activity::wait
1716 .. autodoxymethod:: simgrid::s4u::Activity::wait_for
1717 .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
1718 .. autodoxymethod:: simgrid::s4u::Activity::vetoable_start()
1720 Suspending and resuming an activity
1721 -----------------------------------
1727 .. autodoxymethod:: simgrid::s4u::Activity::suspend
1728 .. autodoxymethod:: simgrid::s4u::Activity::resume
1729 .. autodoxymethod:: simgrid::s4u::Activity::is_suspended
1737 .. autodoxyclass:: simgrid::s4u::Comm
1748 #include <simgrid/s4u/Comm.hpp>
1750 .. doxygentypedef:: CommPtr
1752 .. group-tab:: Python
1756 from simgrid import Comm
1765 .. autodoxymethod:: simgrid::s4u::Comm::get_dst_data_size() const
1766 .. autodoxymethod:: simgrid::s4u::Comm::get_mailbox() const
1767 .. autodoxymethod:: simgrid::s4u::Comm::get_sender() const
1768 .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff)
1769 .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
1770 .. autodoxymethod:: simgrid::s4u::Comm::detach()
1771 .. autodoxymethod:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
1772 .. autodoxymethod:: simgrid::s4u::Comm::set_rate(double rate)
1773 .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff)
1774 .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
1775 .. autodoxymethod:: simgrid::s4u::Comm::set_src_data_size(size_t size)
1776 .. autodoxymethod:: simgrid::s4u::Comm::set_tracing_category(const std::string &category)
1785 .. autodoxymethod:: simgrid::s4u::Comm::cancel
1786 .. autodoxymethod:: simgrid::s4u::Comm::start
1787 .. autodoxymethod:: simgrid::s4u::Comm::test
1788 .. autodoxymethod:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr > *comms)
1789 .. autodoxymethod:: simgrid::s4u::Comm::wait
1790 .. autodoxymethod:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr > *comms)
1791 .. autodoxymethod:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr > *comms)
1792 .. autodoxymethod:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr > *comms_in, double timeout)
1793 .. autodoxymethod:: simgrid::s4u::Comm::wait_for
1795 .. group-tab:: Python
1797 .. automethod:: simgrid.Comm.test
1798 .. automethod:: simgrid.Comm.wait
1799 .. automethod:: simgrid.Comm.wait_all
1800 .. automethod:: simgrid.Comm.wait_any
1809 .. autodoxyvar:: simgrid::s4u::Comm::on_completion
1810 .. autodoxyvar:: simgrid::s4u::Comm::on_receiver_start
1811 .. autodoxyvar:: simgrid::s4u::Comm::on_sender_start
1819 .. autodoxyclass:: simgrid::s4u::Exec
1830 #include <simgrid/s4u/Exec.hpp>
1832 .. doxygentypedef:: ExecPtr
1834 .. group-tab:: Python
1838 from simgrid import Exec
1847 .. autodoxymethod:: simgrid::s4u::Exec::get_cost() const
1848 .. autodoxymethod:: simgrid::s4u::Exec::get_finish_time() const
1849 .. autodoxymethod:: simgrid::s4u::Exec::get_host() const
1850 .. autodoxymethod:: simgrid::s4u::Exec::get_host_number() const
1851 .. cpp:function:: double Exec::get_remaining()
1853 On sequential executions, returns the amount of flops that remain to be done;
1854 This cannot be used on parallel executions.
1856 .. autodoxymethod:: simgrid::s4u::Exec::get_remaining_ratio
1857 .. autodoxymethod:: simgrid::s4u::Exec::get_start_time() const
1858 .. autodoxymethod:: simgrid::s4u::Exec::set_bound(double bound)
1859 .. autodoxymethod:: simgrid::s4u::Exec::set_host
1860 .. autodoxymethod:: simgrid::s4u::Exec::set_priority(double priority)
1862 .. group-tab:: Python
1864 .. autoattribute:: simgrid.Exec.host
1865 .. autoattribute:: simgrid.Exec.remaining
1866 .. autoattribute:: simgrid.Exec.remaining_ratio
1875 .. autodoxymethod:: simgrid::s4u::Exec::cancel
1876 .. autodoxymethod:: simgrid::s4u::Exec::set_timeout(double timeout)
1877 .. autodoxymethod:: simgrid::s4u::Exec::start
1878 .. autodoxymethod:: simgrid::s4u::Exec::test
1879 .. autodoxymethod:: simgrid::s4u::Exec::wait
1880 .. autodoxymethod:: simgrid::s4u::Exec::wait_any(std::vector< ExecPtr > *execs)
1881 .. autodoxymethod:: simgrid::s4u::Exec::wait_any_for(std::vector< ExecPtr > *execs, double timeout)
1882 .. autodoxymethod:: simgrid::s4u::Exec::wait_for
1884 .. group-tab:: Python
1886 .. automethod:: simgrid.Exec.cancel
1887 .. automethod:: simgrid.Exec.start
1888 .. automethod:: simgrid.Exec.test
1889 .. automethod:: simgrid.Exec.wait
1898 .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion
1899 .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_start
1907 .. autodoxyclass:: simgrid::s4u::Io
1918 #include <simgrid/s4u/Io.hpp>
1920 .. doxygentypedef:: IoPtr
1929 .. autodoxymethod:: simgrid::s4u::Io::get_performed_ioops() const
1930 .. autodoxymethod:: simgrid::s4u::Io::get_remaining
1939 .. autodoxymethod:: simgrid::s4u::Io::cancel
1940 .. autodoxymethod:: simgrid::s4u::Io::start
1941 .. autodoxymethod:: simgrid::s4u::Io::test
1942 .. autodoxymethod:: simgrid::s4u::Io::wait
1943 .. autodoxymethod:: simgrid::s4u::Io::wait_for
1945 .. _API_s4u_Synchronizations:
1947 =======================
1948 Synchronization Objects
1949 =======================
1957 .. autodoxyclass:: simgrid::s4u::Mutex
1968 #include <simgrid/s4u/Mutex.hpp>
1970 .. doxygentypedef:: MutexPtr
1972 .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
1973 .. autodoxymethod:: simgrid::s4u::Mutex::create()
1974 .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
1980 #include <simgrid/mutex.h>
1982 .. doxygentypedef:: sg_mutex_t
1983 .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
1985 Pointer to a constant mutex object.
1987 .. autodoxymethod:: sg_mutex_init()
1988 .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
1997 .. autodoxymethod:: simgrid::s4u::Mutex::lock()
1998 .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
1999 .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
2003 .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
2004 .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
2005 .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
2007 .. _API_s4u_Barrier:
2013 .. autodoxyclass:: simgrid::s4u::Barrier
2021 #include <simgrid/s4u/Barrier.hpp>
2023 .. doxygentypedef:: BarrierPtr
2025 .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
2026 .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
2027 .. autodoxymethod:: simgrid::s4u::Barrier::wait()
2033 #include <simgrid/barrier.hpp>
2035 .. doxygentypedef:: sg_bar_t
2036 .. cpp:type:: const s4u_Barrier* const_sg_bar_t
2038 Pointer to a constant barrier object.
2040 .. autodoxymethod:: sg_barrier_init(unsigned int count)
2041 .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
2042 .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
2045 .. _API_s4u_ConditionVariable:
2047 ==========================
2048 Condition variable
2049 ==========================
2051 .. autodoxyclass:: simgrid::s4u::ConditionVariable
2062 #include <simgrid/s4u/ConditionVariable.hpp>
2064 .. doxygentypedef:: ConditionVariablePtr
2066 .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
2072 #include <simgrid/cond.h>
2074 .. doxygentypedef:: sg_cond_t
2075 .. autodoxymethod:: sg_cond_init
2076 .. autodoxymethod:: sg_cond_destroy
2078 Waiting and notifying
2079 ---------------------
2085 .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
2086 .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
2087 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
2088 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
2089 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
2090 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
2091 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
2092 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
2093 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
2094 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
2095 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
2096 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
2097 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
2101 .. autodoxymethod:: sg_cond_notify_all
2102 .. autodoxymethod:: sg_cond_notify_one
2103 .. autodoxymethod:: sg_cond_wait
2104 .. autodoxymethod:: sg_cond_wait_for
2106 .. _API_s4u_Semaphore:
2112 .. autodoxyclass:: simgrid::s4u::Semaphore
2124 #include <simgrid/s4u/Semaphore.hpp>
2126 .. doxygentypedef:: SemaphorePtr
2127 .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
2128 .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
2129 .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
2135 #include <simgrid/semaphore.h>
2137 .. doxygentypedef:: sg_sem_t
2138 .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
2140 Pointer to a constant semaphore object.
2142 .. autodoxymethod:: sg_sem_init(int initial_value)
2143 .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
2152 .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
2153 .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
2154 .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity()
2155 .. autodoxymethod:: simgrid::s4u::Semaphore::release()
2156 .. autodoxymethod:: simgrid::s4u::Semaphore::would_block()
2160 .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
2161 .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
2162 .. autodoxymethod:: sg_sem_get_capacity(sg_sem_t sem)
2163 .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
2164 .. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)