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:: aid_t
406 #include <simgrid/s4u/Actor.hpp>
408 .. doxygentypedef:: ActorPtr
410 .. group-tab:: Python
414 from simgrid import Actor
420 #include <simgrid/actor.h>
422 .. doxygentypedef:: sg_actor_t
423 .. cpp:type:: const s4u_Actor* const_sg_actor_t
425 Pointer to a constant actor object.
427 .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
428 .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
437 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
438 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
439 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
440 .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
442 .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
443 .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
445 .. group-tab:: Python
447 .. automethod:: simgrid.Actor.create
451 .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
452 .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
454 .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
455 .. autodoxymethod:: sg_actor_detach()
464 .. autodoxymethod:: simgrid::s4u::Actor::by_pid(aid_t pid)
465 .. autodoxymethod:: simgrid::s4u::Actor::self()
467 .. group-tab:: Python
469 .. automethod:: simgrid.Actor.by_pid
470 .. automethod:: simgrid.Actor.self
474 .. autodoxymethod:: sg_actor_by_PID(aid_t pid)
475 .. autodoxymethod:: sg_actor_self()
484 .. autodoxymethod:: simgrid::s4u::Actor::get_cname
485 .. autodoxymethod:: simgrid::s4u::Actor::get_name
486 .. autodoxymethod:: simgrid::s4u::Actor::get_pid
487 .. autodoxymethod:: simgrid::s4u::Actor::get_ppid
488 .. autodoxymethod:: simgrid::s4u::Actor::get_properties() const
489 .. autodoxymethod:: simgrid::s4u::Actor::get_property(const std::string &key) const
490 .. autodoxymethod:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
492 .. autodoxymethod:: simgrid::s4u::Actor::get_host
493 .. autodoxymethod:: simgrid::s4u::Actor::set_host
495 .. autodoxymethod:: simgrid::s4u::Actor::get_refcount()
496 .. autodoxymethod:: simgrid::s4u::Actor::get_impl
498 .. group-tab:: Python
500 .. autoattribute:: simgrid.Actor.name
501 .. autoattribute:: simgrid.Actor.host
502 .. autoattribute:: simgrid.Actor.pid
503 .. autoattribute:: simgrid.Actor.ppid
507 .. autodoxymethod:: sg_actor_get_name(const_sg_actor_t actor)
508 .. autodoxymethod:: sg_actor_get_PID(const_sg_actor_t actor)
509 .. autodoxymethod:: sg_actor_get_PPID(const_sg_actor_t actor)
510 .. autodoxymethod:: sg_actor_get_properties(const_sg_actor_t actor)
511 .. autodoxymethod:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name)
513 .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor)
514 .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host)
516 .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor)
517 .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata)
519 Suspending and resuming actors
520 ------------------------------
526 .. autodoxymethod:: simgrid::s4u::Actor::suspend()
527 .. autodoxymethod:: simgrid::s4u::Actor::resume()
528 .. autodoxymethod:: simgrid::s4u::Actor::is_suspended()
530 .. group-tab:: Python
532 .. automethod:: simgrid.Actor.resume
533 .. automethod:: simgrid.Actor.suspend
534 .. automethod:: simgrid.Actor.is_suspended
538 .. autodoxymethod:: sg_actor_suspend(sg_actor_t actor)
539 .. autodoxymethod:: sg_actor_resume(sg_actor_t actor)
540 .. autodoxymethod:: sg_actor_is_suspended(sg_actor_t actor)
542 Specifying when actors should terminate
543 ---------------------------------------
549 .. autodoxymethod:: simgrid::s4u::Actor::kill()
550 .. autodoxymethod:: simgrid::s4u::Actor::kill_all()
551 .. autodoxymethod:: simgrid::s4u::Actor::set_kill_time(double time)
552 .. autodoxymethod:: simgrid::s4u::Actor::get_kill_time()
554 .. autodoxymethod:: simgrid::s4u::Actor::restart()
555 .. autodoxymethod:: simgrid::s4u::Actor::daemonize()
556 .. autodoxymethod:: simgrid::s4u::Actor::is_daemon
558 .. group-tab:: Python
560 .. automethod:: simgrid.Actor.kill
561 .. automethod:: simgrid.Actor.kill_all
563 .. automethod:: simgrid.Actor.daemonize
564 .. automethod:: simgrid.Actor.is_daemon
568 .. autodoxymethod:: sg_actor_kill(sg_actor_t actor)
569 .. autodoxymethod:: sg_actor_kill_all()
570 .. autodoxymethod:: sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
572 .. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
573 .. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
575 .. _API_s4u_Actor_end:
577 Reacting to the end of actors
578 -----------------------------
584 .. autodoxymethod:: simgrid::s4u::Actor::on_exit
585 .. autodoxymethod:: simgrid::s4u::Actor::join()
586 .. autodoxymethod:: simgrid::s4u::Actor::join(double timeout)
587 .. autodoxymethod:: simgrid::s4u::Actor::set_auto_restart(bool autorestart)
589 .. group-tab:: Python
591 .. automethod:: simgrid.Actor.join
595 .. autodoxymethod:: sg_actor_join(sg_actor_t actor, double timeout)
596 .. autodoxymethod:: sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
605 .. autodoxyvar:: simgrid::s4u::Actor::on_creation
606 .. autodoxyvar:: simgrid::s4u::Actor::on_suspend
607 .. autodoxyvar:: simgrid::s4u::Actor::on_resume
608 .. autodoxyvar:: simgrid::s4u::Actor::on_sleep
609 .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
610 .. autodoxyvar:: simgrid::s4u::Actor::on_termination
611 .. autodoxyvar:: simgrid::s4u::Actor::on_destruction
613 .. _API_s4u_this_actor:
619 These functions can be used in your user code to interact with the actor
620 currently running (the one retrieved with :cpp:func:`simgrid::s4u::Actor::self`).
621 Using these functions can greatly improve the code readability.
630 .. autodoxymethod:: simgrid::s4u::this_actor::get_cname()
631 .. autodoxymethod:: simgrid::s4u::this_actor::get_name()
632 .. autodoxymethod:: simgrid::s4u::this_actor::get_pid()
633 .. autodoxymethod:: simgrid::s4u::this_actor::get_ppid()
634 .. autodoxymethod:: simgrid::s4u::this_actor::is_maestro()
636 .. autodoxymethod:: simgrid::s4u::this_actor::get_host()
637 .. autodoxymethod:: simgrid::s4u::this_actor::set_host(Host *new_host)
639 .. group-tab:: Python
641 .. autofunction:: simgrid.this_actor.get_host
642 .. autofunction:: simgrid.this_actor.set_host
646 .. autodoxymethod:: sg_actor_self_data()
647 .. autodoxymethod:: sg_actor_self_data_set(void *data)
648 .. autodoxymethod:: sg_actor_self_get_name()
649 .. autodoxymethod:: sg_actor_self_get_pid()
650 .. autodoxymethod:: sg_actor_self_get_ppid()
651 .. autodoxymethod:: sg_host_self()
652 .. autodoxymethod:: sg_host_self_get_name()
654 Suspending and resuming
655 -----------------------
661 .. autodoxymethod:: simgrid::s4u::this_actor::suspend()
662 .. autodoxymethod:: simgrid::s4u::this_actor::yield()
664 .. group-tab:: Python
666 .. autofunction:: simgrid.this_actor.suspend
667 .. autofunction:: simgrid.this_actor.yield_
674 .. group-tab:: Python
676 .. autofunction:: simgrid.this_actor.info
677 .. autofunction:: simgrid.this_actor.error
686 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(double duration)
687 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_for(std::chrono::duration< Rep, Period > duration)
688 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(const SimulationTimePoint< Duration > &wakeup_time)
689 .. autodoxymethod:: simgrid::s4u::this_actor::sleep_until(double wakeup_time)
691 .. group-tab:: Python
693 .. autofunction:: simgrid.this_actor.sleep_for
694 .. autofunction:: simgrid.this_actor.sleep_until
698 .. autodoxymethod:: sg_actor_sleep_for(double duration)
700 Simulating executions
701 ---------------------
703 Simulate the execution of some code on this actor. You can either simulate
704 parallel or sequential code, and you can either block upon the termination of
705 the execution, or start an asynchronous activity.
711 .. autodoxymethod:: simgrid::s4u::this_actor::exec_async(double flops_amounts)
712 .. 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)
713 .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
714 .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
715 .. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
716 .. 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)
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, double timeout)
719 .. group-tab:: Python
721 .. autofunction:: simgrid.this_actor.exec_init
722 .. autofunction:: simgrid.this_actor.execute
726 .. autodoxymethod:: sg_actor_self_execute(double flops)
735 .. autodoxymethod:: simgrid::s4u::this_actor::exit()
736 .. autodoxymethod:: simgrid::s4u::this_actor::on_exit(const std::function< void(bool)> &fun)
738 .. group-tab:: Python
740 .. autofunction:: simgrid.this_actor.exit
741 .. autofunction:: simgrid.this_actor.on_exit
749 .. autodoxyclass:: simgrid::s4u::Engine
758 .. autodoxymethod:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
759 .. autodoxymethod:: simgrid::s4u::Engine::is_initialized()
760 .. autodoxymethod:: simgrid::s4u::Engine::shutdown()
761 .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str)
763 .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy)
764 .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf)
765 .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name)
766 .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code)
767 .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
768 .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
769 .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >))
771 .. group-tab:: Python
773 .. automethod:: simgrid.Engine.load_deployment
774 .. automethod:: simgrid.Engine.load_platform
775 .. automethod:: simgrid.Engine.register_actor
779 .. autodoxymethod:: simgrid_init
781 .. autodoxymethod:: simgrid_load_deployment
782 .. autodoxymethod:: simgrid_load_platform
783 .. autodoxymethod:: simgrid_register_default
784 .. autodoxymethod:: simgrid_register_function
793 .. autodoxymethod:: simgrid::s4u::Engine::get_clock()
794 .. autodoxymethod:: simgrid::s4u::Engine::run()
796 .. group-tab:: Python
798 .. automethod:: simgrid.Engine.get_clock
799 .. automethod:: simgrid.Engine.run
803 .. autodoxymethod:: simgrid_get_clock
804 .. autodoxymethod:: simgrid_run
813 .. autodoxymethod:: simgrid::s4u::Engine::get_actor_count()
814 .. autodoxymethod:: simgrid::s4u::Engine::get_all_actors()
815 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_actors(const std::function< bool(ActorPtr)> &filter)
819 .. autodoxymethod:: simgrid_get_actor_count()
828 .. autodoxymethod:: simgrid::s4u::Engine::get_all_hosts()
829 .. autodoxymethod:: simgrid::s4u::Engine::get_host_count()
830 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_hosts(const std::function< bool(Host *)> &filter)
831 .. autodoxymethod:: simgrid::s4u::Engine::host_by_name(const std::string &name)
832 .. autodoxymethod:: simgrid::s4u::Engine::host_by_name_or_null(const std::string &name)
834 .. group-tab:: Python
836 .. automethod:: simgrid.Engine.get_all_hosts
840 See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
849 .. autodoxymethod:: simgrid::s4u::Engine::get_all_links()
850 .. autodoxymethod:: simgrid::s4u::Engine::get_link_count()
851 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_links
852 .. autodoxymethod:: simgrid::s4u::Engine::link_by_name(const std::string &name)
853 .. autodoxymethod:: simgrid::s4u::Engine::link_by_name_or_null(const std::string &name)
855 Interacting with the routing
856 ----------------------------
862 .. autodoxymethod:: simgrid::s4u::Engine::get_all_netpoints()
863 .. autodoxymethod:: simgrid::s4u::Engine::get_filtered_netzones()
864 .. autodoxymethod:: simgrid::s4u::Engine::get_instance()
865 .. autodoxymethod:: simgrid::s4u::Engine::get_netzone_root()
866 .. autodoxymethod:: simgrid::s4u::Engine::netpoint_by_name_or_null(const std::string &name)
867 .. autodoxymethod:: simgrid::s4u::Engine::netzone_by_name_or_null(const std::string &name)
868 .. autodoxymethod:: simgrid::s4u::Engine::set_netzone_root(const NetZone *netzone)
877 .. autodoxyvar:: simgrid::s4u::Engine::on_deadlock
878 .. autodoxyvar:: simgrid::s4u::Engine::on_platform_created
879 .. autodoxyvar:: simgrid::s4u::Engine::on_platform_creation
880 .. autodoxyvar:: simgrid::s4u::Engine::on_simulation_end
881 .. autodoxyvar:: simgrid::s4u::Engine::on_time_advance
889 .. autodoxyclass:: simgrid::s4u::Mailbox
891 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
902 #include <simgrid/s4u/Mailbox.hpp>
904 Note that there is no MailboxPtr type, and that you cannot use the RAII
905 idiom on mailboxes because they are internal objects to the simulation
906 engine. Once created, there is no way to destroy a mailbox before the end
909 .. autodoxymethod:: simgrid::s4u::Mailbox::by_name(const std::string &name)
911 .. group-tab:: Python
913 .. automethod:: simgrid.Mailbox.by_name
922 .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname()
923 .. autodoxymethod:: simgrid::s4u::Mailbox::get_name()
925 .. group-tab:: Python
927 .. autoattribute:: simgrid.Mailbox.name
936 .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes)
937 .. autodoxymethod:: simgrid::s4u::Mailbox::put(void *payload, uint64_t simulated_size_in_bytes, double timeout)
938 .. autodoxymethod:: simgrid::s4u::Mailbox::put_async(void *data, uint64_t simulated_size_in_bytes)
939 .. autodoxymethod:: simgrid::s4u::Mailbox::put_init()
940 .. autodoxymethod:: simgrid::s4u::Mailbox::put_init(void *data, uint64_t simulated_size_in_bytes)
942 .. group-tab:: Python
944 .. automethod:: simgrid.Mailbox.put
945 .. automethod:: simgrid.Mailbox.put_async
955 .. autodoxymethod:: simgrid::s4u::Mailbox::empty()
956 .. autodoxymethod:: simgrid::s4u::Mailbox::front()
957 .. autodoxymethod:: simgrid::s4u::Mailbox::get()
958 .. autodoxymethod:: simgrid::s4u::Mailbox::get(double timeout)
959 .. autodoxymethod:: simgrid::s4u::Mailbox::get_async(void **data)
960 .. autodoxymethod:: simgrid::s4u::Mailbox::get_init()
961 .. autodoxymethod:: simgrid::s4u::Mailbox::iprobe(int type, bool(*match_fun)(void *, void *, kernel::activity::CommImpl *), void *data)
962 .. autodoxymethod:: simgrid::s4u::Mailbox::listen()
963 .. autodoxymethod:: simgrid::s4u::Mailbox::ready()
965 .. group-tab:: Python
967 .. automethod:: simgrid.Mailbox.get
971 .. autodoxymethod:: sg_mailbox_listen(const char *alias)
976 See :ref:`s4u_receiving_actor`.
982 .. autodoxymethod:: simgrid::s4u::Mailbox::get_receiver()
983 .. autodoxymethod:: simgrid::s4u::Mailbox::set_receiver(ActorPtr actor)
987 .. autodoxymethod:: ::sg_mailbox_set_receiver(const char *alias)
989 .. _API_s4u_Resource:
1001 .. autodoxyclass:: simgrid::s4u::Disk
1012 #include <simgrid/s4u/Disk.hpp>
1014 Note that there is no DiskPtr type, and that you cannot use the RAII
1015 idiom on disks because SimGrid does not allow (yet) to create nor
1016 destroy resources once the simulation is started.
1026 .. autodoxymethod:: simgrid::s4u::Disk::get_cname()
1027 .. autodoxymethod:: simgrid::s4u::Disk::get_host()
1028 .. autodoxymethod:: simgrid::s4u::Disk::get_name()
1029 .. autodoxymethod:: simgrid::s4u::Disk::get_properties()
1030 .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key)
1031 .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth()
1032 .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth()
1033 .. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
1042 .. autodoxymethod:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type)
1043 .. autodoxymethod:: simgrid::s4u::Disk::read(sg_size_t size)
1044 .. autodoxymethod:: simgrid::s4u::Disk::read_async(sg_size_t size)
1045 .. autodoxymethod:: simgrid::s4u::Disk::write(sg_size_t size)
1046 .. autodoxymethod:: simgrid::s4u::Disk::write_async(sg_size_t size)
1055 .. autodoxyvar:: simgrid::s4u::Disk::on_creation
1056 .. autodoxyvar:: simgrid::s4u::Disk::on_destruction
1057 .. autodoxyvar:: simgrid::s4u::Disk::on_state_change
1066 .. autodoxyclass:: simgrid::s4u::Host
1077 #include <simgrid/s4u/Host.hpp>
1079 Note that there is no HostPtr type, and that you cannot use the RAII
1080 idiom on hosts because SimGrid does not allow (yet) to create nor
1081 destroy resources once the simulation is started.
1083 .. autodoxymethod:: simgrid::s4u::Host::destroy()
1085 .. group-tab:: Python
1089 from simgrid import Host
1095 #include <simgrid/host.h>
1097 .. doxygentypedef:: sg_host_t
1098 .. cpp:type:: const s4u_Host* const_sg_host_t
1100 Pointer to a constant host object.
1109 See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
1111 .. autodoxymethod:: simgrid::s4u::Host::by_name(const std::string &name)
1112 .. autodoxymethod:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
1113 .. autodoxymethod:: simgrid::s4u::Host::current()
1115 .. group-tab:: Python
1117 See also :py:func:`simgrid.Engine.get_all_hosts`.
1119 .. automethod:: simgrid.Host.by_name
1120 .. automethod:: simgrid.Host.current
1124 .. autodoxymethod:: sg_host_by_name(const char *name)
1125 .. autodoxymethod:: sg_host_count()
1126 .. autodoxymethod:: sg_host_list()
1127 .. autodoxymethod:: sg_hosts_as_dynar()
1136 .. autodoxymethod:: simgrid::s4u::Host::get_cname()
1137 .. autodoxymethod:: simgrid::s4u::Host::get_core_count()
1138 .. autodoxymethod:: simgrid::s4u::Host::get_name()
1139 .. autodoxymethod:: simgrid::s4u::Host::get_available_speed()
1140 .. autodoxymethod:: simgrid::s4u::Host::get_load()
1141 .. autodoxymethod:: simgrid::s4u::Host::get_speed()
1143 .. group-tab:: Python
1145 .. autoattribute:: simgrid.Host.name
1146 .. autoattribute:: simgrid.Host.load
1147 .. autoattribute:: simgrid.Host.pstate
1148 .. autoattribute:: simgrid.Host.speed
1152 .. autodoxymethod:: sg_host_core_count(const_sg_host_t host)
1153 .. autodoxymethod:: sg_host_dump(const_sg_host_t ws)
1154 .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
1155 .. autodoxymethod:: sg_host_load(const_sg_host_t host)
1156 .. autodoxymethod:: sg_host_speed(const_sg_host_t host)
1158 User data and properties
1159 ------------------------
1165 .. autodoxymethod:: simgrid::s4u::Host::get_properties()
1166 .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key)
1167 .. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::map< std::string, std::string > &properties)
1168 .. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
1172 .. autodoxymethod:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
1173 .. autodoxymethod:: sg_host_get_properties(const_sg_host_t host)
1174 .. autodoxymethod:: sg_host_get_property_value(const_sg_host_t host, const char *name)
1175 .. autodoxymethod:: sg_host_extension_create(void(*deleter)(void *))
1176 .. autodoxymethod:: sg_host_extension_get(const_sg_host_t host, size_t rank)
1178 Retrieving components
1179 ---------------------
1185 .. autodoxymethod:: simgrid::s4u::Host::add_disk(Disk *disk)
1186 .. autodoxymethod:: simgrid::s4u::Host::get_actor_count()
1187 .. autodoxymethod:: simgrid::s4u::Host::get_all_actors()
1188 .. autodoxymethod:: simgrid::s4u::Host::get_disks()
1189 .. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
1193 .. autodoxymethod:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
1202 .. autodoxymethod:: simgrid::s4u::Host::is_on()
1203 .. autodoxymethod:: simgrid::s4u::Host::turn_off()
1204 .. autodoxymethod:: simgrid::s4u::Host::turn_on()
1208 .. autodoxymethod:: sg_host_is_on(const_sg_host_t host)
1209 .. autodoxymethod:: sg_host_turn_off(sg_host_t host)
1210 .. autodoxymethod:: sg_host_turn_on(sg_host_t host)
1219 .. autodoxymethod:: simgrid::s4u::Host::get_pstate()
1220 .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count()
1221 .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index)
1222 .. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
1223 .. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
1224 .. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
1226 .. group-tab:: Python
1228 .. automethod:: simgrid.Host.get_pstate_count
1229 .. automethod:: simgrid.Host.get_pstate_speed
1233 .. autodoxymethod:: sg_host_get_available_speed(const_sg_host_t host)
1234 .. autodoxymethod:: sg_host_get_nb_pstates(const_sg_host_t host)
1235 .. autodoxymethod:: sg_host_get_pstate(const_sg_host_t host)
1236 .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
1237 .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
1246 .. autodoxymethod:: simgrid::s4u::Host::exec_async(double flops_amounts)
1247 .. autodoxymethod:: simgrid::s4u::Host::execute(double flops)
1248 .. autodoxymethod:: simgrid::s4u::Host::execute(double flops, double priority)
1250 Platform and routing
1251 --------------------
1257 .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
1258 .. autodoxymethod:: simgrid::s4u::Host::get_netpoint()
1259 .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency)
1260 .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency)
1261 .. autodoxymethod:: simgrid::s4u::Host::send_to(Host *dest, double byte_amount)
1265 .. autodoxymethod:: sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
1266 .. autodoxymethod:: sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
1267 .. autodoxymethod:: sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
1268 .. autodoxymethod:: sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
1277 .. autodoxyvar:: simgrid::s4u::Host::on_creation
1278 .. autodoxyvar:: simgrid::s4u::Host::on_destruction
1279 .. autodoxyvar:: simgrid::s4u::Host::on_speed_change
1280 .. autodoxyvar:: simgrid::s4u::Host::on_state_change
1288 .. autodoxyclass:: simgrid::s4u::Link
1299 #include <simgrid/s4u/Link.hpp>
1301 Note that there is no LinkPtr type, and that you cannot use the RAII
1302 idiom on hosts because SimGrid does not allow (yet) to create nor
1303 destroy resources once the simulation is started.
1305 .. group-tab:: Python
1309 from simgrid import Link
1315 #include <simgrid/link.h>
1317 .. doxygentypedef:: sg_link_t
1318 .. cpp:type:: const s4u_Link* const_sg_link_t
1320 Pointer to a constant link object.
1329 See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
1331 .. autodoxymethod:: simgrid::s4u::Link::by_name(const std::string &name)
1332 .. autodoxymethod:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
1336 .. autodoxymethod:: sg_link_by_name(const char *name)
1337 .. autodoxymethod:: sg_link_count()
1338 .. autodoxymethod:: sg_link_list()
1347 .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth()
1348 .. autodoxymethod:: simgrid::s4u::Link::get_cname()
1349 .. autodoxymethod:: simgrid::s4u::Link::get_latency()
1350 .. autodoxymethod:: simgrid::s4u::Link::get_name()
1351 .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy()
1352 .. autodoxymethod:: simgrid::s4u::Link::get_usage()
1353 .. autodoxymethod:: simgrid::s4u::Link::is_used()
1357 .. autodoxymethod:: sg_link_bandwidth(const_sg_link_t link)
1358 .. autodoxymethod:: sg_link_is_shared(const_sg_link_t link)
1359 .. autodoxymethod:: sg_link_latency(const_sg_link_t link)
1360 .. autodoxymethod:: sg_link_name(const_sg_link_t link)
1362 User data and properties
1363 ------------------------
1369 .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key)
1370 .. autodoxymethod:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
1374 .. autodoxymethod:: sg_link_data(const_sg_link_t link)
1375 .. autodoxymethod:: sg_link_data_set(sg_link_t link, void *data)
1384 See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
1386 .. autodoxymethod:: simgrid::s4u::Link::is_on()
1387 .. autodoxymethod:: simgrid::s4u::Link::turn_off()
1388 .. autodoxymethod:: simgrid::s4u::Link::turn_on()
1397 .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
1398 .. autodoxymethod:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
1399 .. autodoxymethod:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
1408 .. autodoxyvar:: simgrid::s4u::Link::on_bandwidth_change
1409 .. cpp:var:: xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> Link::on_communicate
1410 .. autodoxyvar:: simgrid::s4u::Link::on_communication_state_change
1411 .. autodoxyvar:: simgrid::s4u::Link::on_creation
1412 .. autodoxyvar:: simgrid::s4u::Link::on_destruction
1413 .. autodoxyvar:: simgrid::s4u::Link::on_state_change
1415 .. _API_s4u_NetZone:
1421 .. autodoxyclass:: simgrid::s4u::NetZone
1432 #include <simgrid/s4u/NetZone.hpp>
1434 Note that there is no NetZonePtr type, and that you cannot use the RAII
1435 idiom on network zones because SimGrid does not allow (yet) to create nor
1436 destroy resources once the simulation is started.
1442 #include <simgrid/zone.h>
1444 .. doxygentypedef:: sg_netzone_t
1445 .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
1447 Pointer to a constant network zone object.
1456 See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
1457 :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
1458 :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
1462 .. autodoxymethod:: sg_zone_get_by_name(const char *name)
1463 .. autodoxymethod:: sg_zone_get_root()
1472 .. autodoxymethod:: simgrid::s4u::NetZone::get_cname()
1473 .. autodoxymethod:: simgrid::s4u::NetZone::get_name()
1477 .. autodoxymethod:: sg_zone_get_name(const_sg_netzone_t zone)
1479 User data and properties
1480 ------------------------
1486 .. autodoxymethod:: simgrid::s4u::NetZone::get_properties()
1487 .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key)
1488 .. autodoxymethod:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
1492 .. autodoxymethod:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
1493 .. autodoxymethod:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
1495 Retrieving components
1496 ---------------------
1502 .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts()
1503 .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count()
1507 .. autodoxymethod:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
1516 .. 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)
1517 .. autodoxymethod:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
1518 .. 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)
1519 .. autodoxymethod:: simgrid::s4u::NetZone::get_children()
1520 .. autodoxymethod:: simgrid::s4u::NetZone::get_father()
1524 .. autodoxymethod:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
1533 .. autodoxyvar:: simgrid::s4u::NetZone::on_creation
1534 .. autodoxyvar:: simgrid::s4u::NetZone::on_route_creation
1535 .. autodoxyvar:: simgrid::s4u::NetZone::on_seal
1538 .. doxygenclass:: simgrid::s4u::NetZone
1543 .. _API_s4u_VirtualMachine:
1545 =======================
1546 class VirtualMachine
1547 =======================
1550 .. autodoxyclass:: simgrid::s4u::VirtualMachine
1560 #include <simgrid/s4u/VirtualMachine.hpp>
1562 Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
1563 idiom on virtual machines. There is no good reason for that and should change in the future.
1569 #include <simgrid/vm.h>
1571 .. doxygentypedef:: sg_vm_t
1572 .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
1574 Pointer to a constant virtual machine object.
1583 .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
1584 .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
1585 .. autodoxymethod:: simgrid::s4u::VirtualMachine::destroy()
1589 .. autodoxymethod:: sg_vm_create_core
1590 .. autodoxymethod:: sg_vm_create_multicore
1591 .. autodoxymethod:: sg_vm_destroy
1600 .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_pm()
1601 .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_ramsize()
1602 .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_state()
1604 .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_bound(double bound)
1605 .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
1606 .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
1610 .. autodoxymethod:: sg_vm_get_ramsize(const_sg_vm_t vm)
1611 .. autodoxymethod:: sg_vm_set_bound(sg_vm_t vm, double bound)
1612 .. autodoxymethod:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
1614 .. autodoxymethod:: sg_vm_get_name
1615 .. autodoxymethod:: sg_vm_get_pm
1616 .. autodoxymethod:: sg_vm_is_created
1617 .. autodoxymethod:: sg_vm_is_running
1618 .. autodoxymethod:: sg_vm_is_suspended
1627 .. autodoxymethod:: simgrid::s4u::VirtualMachine::resume()
1628 .. autodoxymethod:: simgrid::s4u::VirtualMachine::shutdown()
1629 .. autodoxymethod:: simgrid::s4u::VirtualMachine::start()
1630 .. autodoxymethod:: simgrid::s4u::VirtualMachine::suspend()
1634 .. autodoxymethod:: sg_vm_start
1635 .. autodoxymethod:: sg_vm_suspend
1636 .. autodoxymethod:: sg_vm_resume
1637 .. autodoxymethod:: sg_vm_shutdown
1646 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_end
1647 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_start
1648 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_resume
1649 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_shutdown
1650 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_start
1651 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_started
1652 .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_suspend
1654 .. _API_s4u_Activity:
1660 .. autodoxyclass:: simgrid::s4u::Activity
1662 **Known subclasses:**
1663 :ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
1664 :ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
1665 :ref:`I/O <API_s4u_Io>` (started on and consumming disks).
1666 See also the :ref:`section on activities <s4u_Activities>` above.
1671 .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
1672 .. autodoxymethod:: simgrid::s4u::Activity::get_state()
1673 .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
1675 Activities life cycle
1676 ---------------------
1678 .. autodoxymethod:: simgrid::s4u::Activity::start
1679 .. autodoxymethod:: simgrid::s4u::Activity::cancel
1680 .. autodoxymethod:: simgrid::s4u::Activity::test
1681 .. autodoxymethod:: simgrid::s4u::Activity::wait
1682 .. autodoxymethod:: simgrid::s4u::Activity::wait_for
1683 .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
1684 .. autodoxymethod:: simgrid::s4u::Activity::vetoable_start()
1692 .. doxygentypedef:: CommPtr
1694 .. doxygenclass:: simgrid::s4u::Comm
1705 .. doxygentypedef:: ExecPtr
1707 .. doxygenclass:: simgrid::s4u::Exec
1712 .. _API_s4u_ExecSeq:
1718 .. doxygentypedef:: ExecSeqPtr
1720 .. doxygenclass:: simgrid::s4u::ExecSeq
1725 .. _API_s4u_ExecPar:
1731 .. doxygentypedef:: ExecParPtr
1733 .. doxygenclass:: simgrid::s4u::ExecPar
1744 .. doxygentypedef:: IoPtr
1746 .. doxygenclass:: simgrid::s4u::Io
1751 .. _API_s4u_Synchronizations:
1753 =======================
1754 Synchronization Objects
1755 =======================
1763 .. autodoxyclass:: simgrid::s4u::Mutex
1774 #include <simgrid/s4u/Mutex.hpp>
1776 .. doxygentypedef:: MutexPtr
1778 .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
1779 .. autodoxymethod:: simgrid::s4u::Mutex::create()
1780 .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
1786 #include <simgrid/mutex.h>
1788 .. doxygentypedef:: sg_mutex_t
1789 .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
1791 Pointer to a constant mutex object.
1793 .. autodoxymethod:: sg_mutex_init()
1794 .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
1803 .. autodoxymethod:: simgrid::s4u::Mutex::lock()
1804 .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
1805 .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
1809 .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
1810 .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
1811 .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
1813 .. _API_s4u_Barrier:
1819 .. autodoxyclass:: simgrid::s4u::Barrier
1827 #include <simgrid/s4u/Barrier.hpp>
1829 .. doxygentypedef:: BarrierPtr
1831 .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
1832 .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
1833 .. autodoxymethod:: simgrid::s4u::Barrier::wait()
1839 #include <simgrid/barrier.hpp>
1841 .. doxygentypedef:: sg_bar_t
1842 .. cpp:type:: const s4u_Barrier* const_sg_bar_t
1844 Pointer to a constant barrier object.
1846 .. autodoxymethod:: sg_barrier_init(unsigned int count)
1847 .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
1848 .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
1851 .. _API_s4u_ConditionVariable:
1853 ==========================
1854 Condition variable
1855 ==========================
1857 .. autodoxyclass:: simgrid::s4u::ConditionVariable
1868 #include <simgrid/s4u/ConditionVariable.hpp>
1870 .. doxygentypedef:: ConditionVariablePtr
1872 .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
1878 #include <simgrid/cond.h>
1880 .. doxygentypedef:: sg_cond_t
1881 .. doxygenfunction:: sg_cond_init
1882 .. doxygenfunction:: sg_cond_destroy
1884 Waiting and notifying
1885 ---------------------
1891 .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
1892 .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
1893 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
1894 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
1895 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
1896 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
1897 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
1898 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration)
1899 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, std::chrono::duration< Rep, Period > duration, P pred)
1900 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time)
1901 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, const SimulationTimePoint< Duration > &timeout_time, P pred)
1902 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time)
1903 .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_until(const std::unique_lock< s4u::Mutex > &lock, double timeout_time, P pred)
1907 .. doxygenfunction:: sg_cond_notify_all
1908 .. doxygenfunction:: sg_cond_notify_one
1909 .. doxygenfunction:: sg_cond_wait
1910 .. doxygenfunction:: sg_cond_wait_for
1912 .. _API_s4u_Semaphore:
1918 .. autodoxyclass:: simgrid::s4u::Semaphore
1930 #include <simgrid/s4u/Semaphore.hpp>
1932 .. doxygentypedef:: SemaphorePtr
1933 .. autodoxymethod:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity)
1934 .. autodoxymethod:: simgrid::s4u::Semaphore::~Semaphore()
1935 .. autodoxymethod:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity)
1941 #include <simgrid/semaphore.h>
1943 .. doxygentypedef:: sg_sem_t
1944 .. cpp:type:: const s4u_Semaphore* const_sg_sem_t
1946 Pointer to a constant semaphore object.
1948 .. autodoxymethod:: sg_sem_init(int initial_value)
1949 .. autodoxymethod:: sg_sem_destroy(const_sg_sem_t sem)
1958 .. autodoxymethod:: simgrid::s4u::Semaphore::acquire()
1959 .. autodoxymethod:: simgrid::s4u::Semaphore::acquire_timeout(double timeout)
1960 .. autodoxymethod:: simgrid::s4u::Semaphore::get_capacity()
1961 .. autodoxymethod:: simgrid::s4u::Semaphore::release()
1962 .. autodoxymethod:: simgrid::s4u::Semaphore::would_block()
1966 .. autodoxymethod:: sg_sem_acquire(sg_sem_t sem)
1967 .. autodoxymethod:: sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
1968 .. autodoxymethod:: sg_sem_get_capacity(sg_sem_t sem)
1969 .. autodoxymethod:: sg_sem_release(sg_sem_t sem)
1970 .. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)