settings.
Since v3.20 (June 2018), S4U is the way to go for long-term
-projects. It is feature complete, but may still evolve slightly in
+projects. It is feature complete, but may still evolve slightly in
future releases. It can already be used to do everything that can be
done in SimGrid, but you may have to adapt your code in future
releases. When this happens, compiling your code will produce
deprecation warnings for 4 releases (one year) before the removal of
-the old symbols.
+the old symbols.
If you want an API that will never ever evolve in the future, you
-should use the :ref:`deprecated MSG API <MSG_doc>` instead.
+should use the :ref:`deprecated MSG API <MSG_doc>` instead.
Main Concepts
*************
**********
Activities represent the actions that consume a resource, such as a
-:ref:`Comm <API_s4u_Comm>` that consumes the *transmitting power* of
+:ref:`Comm <API_s4u_Comm>` that consumes the *transmitting power* of
:ref:`Link <API_s4u_Link>` resources, or an :ref:`Exec <API_s4u_Exec>`
that consumes the *computing power* of :ref:`Host <API_s4u_Host>` resources.
See also the :ref:`full API <API_s4u_Activity>` below.
Every kind of activity can be asynchronous:
- - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
+ - :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
:cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>` and
:cpp:func:`s4u::Mailbox::get_async() <simgrid::s4u::Mailbox::get_async>`.
- - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
+ - :ref:`s4u::IoPtr <API_s4u_Io>` are created with
:cpp:func:`s4u::Disk::read_async() <simgrid::s4u::Disk::read_async>` and
:cpp:func:`s4u::Disk::write_async() <simgrid::s4u::Disk::write_async>`.
- :ref:`s4u::ExecPtr <API_s4u_Exec>` are created with
:dedent: 4
Then, you start all the communications that should occur concurrently with
-:cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
+:cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.
Finally, the actor waits for the completion of all of them at once
-with
-:cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
-
+with
+:cpp:func:`s4u::Comm::wait_all() <simgrid::s4u::Comm::wait_all>`.
+
.. literalinclude:: ../../examples/cpp/comm-waitall/s4u-comm-waitall.cpp
:language: c++
:start-after: put-begin
Activities Life cycle
=====================
-Sometimes, you want to change the setting of an activity before it even starts.
+Sometimes, you want to change the setting of an activity before it even starts.
.. todo:: write this section
.. _s4u_mailbox:
-
+
Mailboxes
*********
They are similar to many common things: The phone number, which allows
the caller to find the receiver. The Twitter hashtag, which helps
-senders and receivers to find each other. In TCP, the pair
+senders and receivers to find each other. In TCP, the pair
``{host name, host port}`` to which you can connect to find your peer.
-In HTTP, URLs through which the clients can connect to the servers.
+In HTTP, URLs through which the clients can connect to the servers.
In ZeroMQ, the queues are used to match senders and receivers.
One big difference with most of these systems is that no actor is the
A big difference with the ZeroMQ queues is that you cannot filter
on the data you want to get from the mailbox. To model such settings
in SimGrid, you'd have one mailbox per potential topic, and subscribe
-to each topic individually with a
+to each topic individually with a
:cpp:func:`get_async() <simgrid::s4u::Mailbox::get_async>` on each mailbox.
-Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any>`
+Then, use :cpp:func:`Comm::wait_any() <simgrid::s4u::Comm::wait_any>`
to get the first message on any of the mailboxes you are subscribed to.
The mailboxes are not located on the network, and you can access
The last twist is that by default in the simulator, the data starts
to be exchanged only when both the sender and the receiver are
announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
-and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
+and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted).
In TCP, since you establish connections beforehand, the data starts to
flow as soon as the sender posts it, even if the receiver did not post
-its :cpp:func:`put() <simgrid::s4u::Mailbox::put()>` yet.
+its :cpp:func:`put() <simgrid::s4u::Mailbox::put()>` yet.
To model this in SimGrid, you can declare a specific receiver to a
-given mailbox (with the function
-:cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
+given mailbox (with the function
+:cpp:func:`set_receiver() <simgrid::s4u::Mailbox::set_receiver()>`).
That way, any :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
posted to that mailbox will start as soon as possible, and the data
will already be there on the receiver host when the receiver actor
.. code-block:: cpp
- void myFunc()
+ void myFunc()
{
simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create(); // Too bad we cannot use `new`
mutex->lock(); // use the mutex as a simple reference
// bla bla
- mutex->unlock();
-
+ mutex->unlock();
+
} // The mutex gets automatically freed because the only existing reference gets out of scope
Note that Mailboxes, Hosts, and Links are not handled through smart
class Actor
==============
-.. doxygenclass:: simgrid::s4u::Actor
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Actor
-.. doxygentypedef:: aid_t
+ .. doxygentypedef:: aid_t
+
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Actor
Basic management
----------------
from simgrid import Actor
- .. autoclass:: simgrid.Actor
-
.. group-tab:: C
.. code:: C
#include <simgrid/actor.h>
.. doxygentypedef:: sg_actor_t
- .. cpp:type:: const s4u_Actor* const_sg_actor_t
-
- Pointer to a constant actor object.
-
+ .. doxygentypedef:: const_sg_actor_t
.. doxygenfunction:: sg_actor_ref
.. doxygenfunction:: sg_actor_unref
.. doxygenfunction:: simgrid::s4u::Actor::get_ppid
.. doxygenfunction:: simgrid::s4u::Actor::get_properties() const
.. doxygenfunction:: simgrid::s4u::Actor::get_property(const std::string &key) const
- .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
+ .. doxygenfunction:: simgrid::s4u::Actor::set_property(const std::string &key, const std::string &value)
.. doxygenfunction:: simgrid::s4u::Actor::get_host
.. doxygenfunction:: simgrid::s4u::Actor::set_host
.. doxygenfunction:: simgrid::s4u::Actor::get_impl
.. group-tab:: Python
-
+
.. autoattribute:: simgrid.Actor.name
.. autoattribute:: simgrid.Actor.host
.. autoattribute:: simgrid.Actor.pid
.. autofunction:: simgrid.this_actor.get_host
.. autofunction:: simgrid.this_actor.set_host
+ .. autofunction:: simgrid.this_actor.get_pid()
+ .. autofunction:: simgrid.this_actor.get_ppid()
+
.. group-tab:: C
.. doxygenfunction:: sg_actor_self_get_data()
.. tabs::
+ .. group-tab:: C++
+
+ Please refer to :ref:`the relevant documentation <logging_prog>`.
+
.. group-tab:: Python
+ .. autofunction:: simgrid.this_actor.debug
.. autofunction:: simgrid.this_actor.info
.. autofunction:: simgrid.this_actor.error
.. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop)
.. doxygenfunction:: simgrid::s4u::this_actor::execute(double flop, double priority)
.. doxygenfunction:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
- .. doxygenfunction:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
.. group-tab:: Python
Simulation Engine
====================
-.. doxygenclass:: simgrid::s4u::Engine
+.. tabs::
-Initialization
---------------
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Engine
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Engine
+
+Engin initialization
+--------------------
.. tabs::
.. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
.. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
.. doxygenfunction:: simgrid::s4u::Engine::shutdown()
+ .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Engine.__init__
+ .. automethod:: simgrid.Engine.instance
+
+ .. group-tab:: C
+
+ .. doxygenfunction:: simgrid_init
+
+Simulation setup
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
.. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
.. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
.. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
.. doxygenfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
.. group-tab:: Python
-
+
.. automethod:: simgrid.Engine.load_deployment
.. automethod:: simgrid.Engine.load_platform
.. automethod:: simgrid.Engine.register_actor
.. group-tab:: C
- .. doxygenfunction:: simgrid_init
-
.. doxygenfunction:: simgrid_load_deployment
.. doxygenfunction:: simgrid_load_platform
.. doxygenfunction:: simgrid_register_default
.. doxygenfunction:: simgrid_register_function
+
Run the simulation
------------------
.. doxygenfunction:: simgrid::s4u::Engine::get_clock()
.. doxygenfunction:: simgrid::s4u::Engine::run
+ .. doxygenfunction:: simgrid::s4u::Engine::run_until
.. group-tab:: Python
-
+
.. automethod:: simgrid.Engine.get_clock
.. automethod:: simgrid.Engine.run
+ .. automethod:: simgrid.Engine.run_until
.. group-tab:: C
.. doxygenfunction:: simgrid_get_clock
.. doxygenfunction:: simgrid_run
+ .. doxygenfunction:: simgrid_run_until
Retrieving actors
-----------------
.. group-tab:: C
- .. doxygenfunction:: simgrid_get_actor_count()
+ .. doxygenfunction:: sg_actor_count()
Retrieving hosts
----------------
.. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
.. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
- .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
.. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
.. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
.. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
class Mailbox
================
-.. doxygenclass:: simgrid::s4u::Mailbox
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Mailbox
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Mailbox
Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
idiom on mailboxes because they are internal objects to the simulation
engine. Once created, there is no way to destroy a mailbox before the end
of the simulation.
-
+
.. doxygenfunction:: simgrid::s4u::Mailbox::by_name(const std::string &name)
.. group-tab:: Python
#include <simgrid/mailbox.h>
- .. autoclass:: simgrid.Mailbox
-
.. automethod:: simgrid.Mailbox.by_name
.. group-tab:: C
.. code-block:: C
#include <simgrid/s4u/mailbox.h>
-
+
.. doxygentypedef:: sg_mailbox_t
.. doxygentypedef:: const_sg_mailbox_t
.. group-tab:: Python
.. automethod:: simgrid.Mailbox.get
+ .. automethod:: simgrid.Mailbox.get_async
.. group-tab:: C
.. group-tab:: C
.. doxygenfunction:: sg_mailbox_set_receiver(const char *alias)
-
+
.. _API_s4u_Resource:
=========
class Disk
=============
-.. doxygenclass:: simgrid::s4u::Disk
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Disk
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Disk
Basic management
----------------
Note that there is no DiskPtr type and that you cannot use the RAII
idiom on disks because SimGrid does not allow (yet) to create nor
- destroy resources once the simulation is started.
-
+ destroy resources once the simulation is started.
+
+ .. doxygenfunction:: simgrid::s4u::Disk::seal()
+
+ .. group-tab:: Python
+
+ .. code:: Python
+
+ from simgrid import Disk
+
+ .. automethod:: simgrid.Disk.seal
+
Querying info
-------------
.. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const
.. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const
.. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
+ .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
+
+ .. group-tab:: Python
+
+ .. autoattribute:: simgrid.Disk.name
+ .. automethod:: simgrid.Disk.set_sharing_policy
I/O operations
--------------
.. doxygenfunction:: simgrid::s4u::Disk::write(sg_size_t size) const
.. doxygenfunction:: simgrid::s4u::Disk::write_async(sg_size_t size) const
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Disk.read
+ .. automethod:: simgrid.Disk.read_async
+ .. automethod:: simgrid.Disk.write
+ .. automethod:: simgrid.Disk.write_async
+
Signals
-------
class Host
=============
-.. doxygenclass:: simgrid::s4u::Host
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Host
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Host
Basic management
----------------
Note that there is no HostPtr type, and that you cannot use the RAII
idiom on hosts because SimGrid does not allow (yet) to create nor
- destroy resources once the simulation is started.
+ destroy resources once the simulation is started.
.. doxygenfunction:: simgrid::s4u::Host::destroy()
+ .. doxygenfunction:: simgrid::s4u::Host::seal()
.. group-tab:: Python
from simgrid import Host
+ .. automethod:: simgrid.Host.seal
+
.. group-tab:: C
.. code:: C
.. doxygenfunction:: sg_host_by_name(const char *name)
.. doxygenfunction:: sg_host_count()
.. doxygenfunction:: sg_host_list()
- .. doxygenfunction:: sg_hosts_as_dynar()
+
+Modifying characteristics
+-------------------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count)
+ .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords)
+ .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {})
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Host.set_core_count
+ .. automethod:: simgrid.Host.set_coordinates
+ .. automethod:: simgrid.Host.set_sharing_policy
Querying info
-------------
.. doxygenfunction:: simgrid::s4u::Host::get_disks() const
.. doxygenfunction:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Host.get_disks
+
.. group-tab:: C
.. doxygenfunction:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
.. doxygenfunction:: simgrid::s4u::Host::get_pstate() const
.. doxygenfunction:: simgrid::s4u::Host::get_pstate_count() const
- .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
- .. doxygenfunction:: simgrid::s4u::Host::set_pstate(int pstate_index)
+ .. doxygenfunction:: simgrid::s4u::Host::get_pstate_speed(unsigned long pstate_index) const
+ .. doxygenfunction:: simgrid::s4u::Host::set_pstate(unsigned long pstate_index)
.. doxygenfunction:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
.. doxygenfunction:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
.. doxygenfunction:: sg_host_get_available_speed(const_sg_host_t host)
.. doxygenfunction:: sg_host_get_nb_pstates(const_sg_host_t host)
.. doxygenfunction:: sg_host_get_pstate(const_sg_host_t host)
- .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
- .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, int pstate)
+ .. doxygenfunction:: sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
+ .. doxygenfunction:: sg_host_set_pstate(sg_host_t host, unsigned long pstate)
Execution
---------
.. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const
.. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const
.. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const
+ .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
+ .. doxygenfunction:: simgrid::s4u::Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Host.get_netpoint
+ .. automethod:: simgrid.Host.create_disk
.. group-tab:: C
class Link
=============
-.. doxygenclass:: simgrid::s4u::Link
-.. doxygenclass:: simgrid::s4u::SplitDuplexLink
-.. doxygenclass:: simgrid::s4u::LinkInRoute
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Link
+ .. doxygenclass:: simgrid::s4u::SplitDuplexLink
+ .. doxygenclass:: simgrid::s4u::LinkInRoute
+
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Link
Basic management
----------------
Note that there is no LinkPtr type and that you cannot use the RAII
idiom on hosts because SimGrid does not allow (yet) to create nor
- destroy resources once the simulation is started.
+ destroy resources once the simulation is started.
+
+ .. doxygenfunction:: simgrid::s4u::Link::seal()
.. group-tab:: Python
from simgrid import Link
+ .. automethod:: simgrid.Link.seal
+
.. group-tab:: C
.. code:: C
.. doxygenfunction:: simgrid::s4u::Link::by_name(const std::string &name)
.. doxygenfunction:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Link.by_name
+ .. autoattribute:: simgrid.Link.name
+
.. group-tab:: C
.. doxygenfunction:: sg_link_by_name(const char *name)
.. doxygenfunction:: simgrid::s4u::Link::set_bandwidth(double value)
.. doxygenfunction:: simgrid::s4u::Link::set_latency(double value)
+ .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value)
+ .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit)
+ .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {})
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Link.set_latency
+ .. automethod:: simgrid.Link.set_concurrency_limit
+ .. automethod:: simgrid.Link.set_sharing_policy
.. group-tab:: C
.. doxygenfunction:: simgrid::s4u::Link::set_host_wifi_rate
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Link.set_host_wifi_rate
+
Signals
-------
.. group-tab:: C++
.. doxygenvariable:: simgrid::s4u::Link::on_bandwidth_change
- .. doxygenvariable:: simgrid::s4u::Link::on_communicate
.. doxygenvariable:: simgrid::s4u::Link::on_communication_state_change
.. doxygenvariable:: simgrid::s4u::Link::on_creation
.. doxygenvariable:: simgrid::s4u::Link::on_destruction
class NetZone
================
-.. doxygenclass:: simgrid::s4u::NetZone
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::NetZone
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.NetZone
Basic management
----------------
Note that there is no NetZonePtr type and that you cannot use the RAII
idiom on network zones because SimGrid does not allow (yet) to create nor
- destroy resources once the simulation is started.
+ destroy resources once the simulation is started.
+
+ .. doxygenfunction:: simgrid::s4u::NetZone::seal
+
+ .. group-tab:: Python
+
+ .. code:: Python
+
+ from simgrid import NetZone
+
+ .. automethod:: simgrid.NetZone.seal
.. group-tab:: C
.. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const
.. doxygenfunction:: simgrid::s4u::NetZone::get_name() const
+ .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint()
+
+ .. group-tab:: Python
+
+ .. autoattribute:: simgrid.NetZone.name
+ .. automethod:: simgrid.NetZone.get_netpoint
.. group-tab:: C
.. doxygenfunction:: simgrid::s4u::NetZone::get_property(const std::string &key) const
.. doxygenfunction:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.NetZone.set_property
+
.. group-tab:: C
.. doxygenfunction:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
.. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
.. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
.. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
+ .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent)
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.NetZone.add_route
+ .. automethod:: simgrid.NetZone.set_parent
.. group-tab:: C
.. doxygenvariable:: simgrid::s4u::NetZone::on_creation
.. doxygenvariable:: simgrid::s4u::NetZone::on_seal
+Creating resources
+------------------
+
+Zones
+^^^^^
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name)
+ .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name)
+ .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name)
+ .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache)
+ .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name)
+ .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name)
+ .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name)
+ .. doxygenfunction:: simgrid::s4u::create_torus_zone
+ .. doxygenfunction:: simgrid::s4u::create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
+ .. doxygenfunction:: simgrid::s4u::create_dragonfly_zone(const std::string& name, const NetZone* parent, const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy)
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.NetZone.create_full_zone
+ .. automethod:: simgrid.NetZone.create_empty_zone
+ .. automethod:: simgrid.NetZone.create_star_zone
+ .. automethod:: simgrid.NetZone.create_dijkstra_zone
+ .. automethod:: simgrid.NetZone.create_floyd_zone
+ .. automethod:: simgrid.NetZone.create_vivaldi_zone
+ .. automethod:: simgrid.NetZone.create_wifi_zone
+ .. automethod:: simgrid.NetZone.create_torus_zone
+ .. automethod:: simgrid.NetZone.create_fatTree_zone
+ .. automethod:: simgrid.NetZone.create_dragonfly_zone
+
+Hosts
+^^^^^
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed)
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.NetZone.create_host
+
+Links
+^^^^^
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidthds)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.NetZone.create_link
+ .. automethod:: simgrid.NetZone.create_split_duplex_link
+
+Router
+^^^^^^
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenfunction:: simgrid::s4u::NetZone::create_router(const std::string& name)
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.NetZone.create_router
+
.. _API_s4u_VirtualMachine:
=======================
.. group-tab:: C++
- .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
- .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
+ .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount)
+ .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount, size_t ramsize)
.. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
.. group-tab:: C
.. group-tab:: C++
+ .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_creation
+ .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_destruction
.. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_end
.. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_start
.. doxygenvariable:: simgrid::s4u::VirtualMachine::on_resume
.. _API_s4u_Activity:
+==========
+Activities
+==========
+
==============
class Activity
==============
**Known subclasses:**
:ref:`Communications <API_s4u_Comm>` (started on Mailboxes and consuming links),
:ref:`Executions <API_s4u_Exec>` (started on Host and consuming CPU resources)
-:ref:`I/O <API_s4u_Io>` (started on and consumming disks).
+:ref:`I/O <API_s4u_Io>` (started on and consuming disks).
See also the :ref:`section on activities <s4u_Activities>` above.
Basic management
class Comm
=============
-.. doxygenclass:: simgrid::s4u::Comm
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Comm
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Comm
Basic management
----------------
from simgrid import Comm
- .. autoclass:: simgrid.Comm
-
.. group-tab:: c
.. code:: c
.. doxygenfunction:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
.. doxygenfunction:: simgrid::s4u::Comm::detach()
.. doxygenfunction:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
- .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(double bytes)
+ .. doxygenfunction:: simgrid::s4u::Comm::set_payload_size(uint64_t bytes)
.. doxygenfunction:: simgrid::s4u::Comm::set_rate(double rate)
.. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff)
.. doxygenfunction:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
.. group-tab:: C++
.. doxygenfunction:: simgrid::s4u::Comm::sendto
- .. doxygenfunction:: simgrid::s4u::Comm::sendto_init
+ .. doxygenfunction:: simgrid::s4u::Comm::sendto_init()
+ .. doxygenfunction:: simgrid::s4u::Comm::sendto_init(Host *from, Host *to)
.. doxygenfunction:: simgrid::s4u::Comm::sendto_async
-
+
.. doxygenfunction:: simgrid::s4u::Comm::cancel
.. doxygenfunction:: simgrid::s4u::Comm::start
.. doxygenfunction:: simgrid::s4u::Comm::test
.. group-tab:: C++
.. doxygenvariable:: simgrid::s4u::Comm::on_completion
- .. doxygenvariable:: simgrid::s4u::Comm::on_start
+ .. doxygenvariable:: simgrid::s4u::Comm::on_recv
+ .. doxygenvariable:: simgrid::s4u::Comm::on_send
.. _API_s4u_Exec:
class Exec
=============
-.. doxygenclass:: simgrid::s4u::Exec
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Exec
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Exec
Basic management
----------------
from simgrid import Exec
- .. autoclass:: simgrid.Exec
-
.. group-tab:: C
.. code-block:: C
.. autoattribute:: simgrid.Exec.remaining_ratio
.. group-tab:: C
-
+
.. doxygenfunction:: sg_exec_set_bound(sg_exec_t exec, double bound)
.. doxygenfunction:: sg_exec_get_name(const_sg_exec_t exec)
.. doxygenfunction:: sg_exec_set_name(sg_exec_t exec, const char* name)
.. automethod:: simgrid.Exec.wait
.. group-tab:: C
-
+
.. doxygenfunction:: sg_exec_start(sg_exec_t exec)
.. doxygenfunction:: sg_exec_cancel(sg_exec_t exec);
.. doxygenfunction:: sg_exec_test(sg_exec_t exec);
class Io
===========
-.. doxygenclass:: simgrid::s4u::Io
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. doxygenclass:: simgrid::s4u::Io
+
+ .. group-tab:: Python
+
+ .. autoclass:: simgrid.Io
Basic management
----------------
.. doxygenfunction:: simgrid::s4u::Io::test
.. doxygenfunction:: simgrid::s4u::Io::wait
.. doxygenfunction:: simgrid::s4u::Io::wait_for
+ .. doxygenfunction:: simgrid::s4u::Io::wait_any
+ .. doxygenfunction:: simgrid::s4u::Io::wait_any_for
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Io.test
+ .. automethod:: simgrid.Io.wait
+ .. automethod:: simgrid.Io.wait_any_for
+ .. automethod:: simgrid.Io.wait_any
.. _API_s4u_Synchronizations:
