Finally, to wait at most until a specified time limit, use
:cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
-.. todo::
-
- wait_for and wait_until are currently not implemented for Exec and Io activities.
-
Every kind of activity can be asynchronous:
- :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
.. autodoxyclass:: simgrid::s4u::Actor
-.. doxygentypedef:: ActorPtr
-
.. doxygentypedef:: aid_t
-Creating actors
----------------
+Basic management
+----------------
.. tabs::
.. code:: C++
- #include <simgrid/s4u/Engine.hpp>
-
- .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
- .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
- .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
- .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
+ #include <simgrid/s4u/Actor.hpp>
- .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
- .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
+ .. doxygentypedef:: ActorPtr
.. group-tab:: Python
from simgrid import Actor
- .. automethod:: simgrid.Actor.create
-
.. group-tab:: C
.. code:: C
Pointer to a constant actor object.
+ .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
+ .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
+
+Creating actors
+---------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
+ .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
+ .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
+ .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
+
+ .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
+ .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Actor.create
+
+ .. group-tab:: C
+
.. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
- .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
+ .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char *const *argv)
.. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
.. autodoxymethod:: sg_actor_detach()
- .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
- .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
-
-Searching specific actors
--------------------------
+Retrieving actors
+-----------------
.. tabs::
.. autodoxymethod:: sg_actor_by_PID(aid_t pid)
.. autodoxymethod:: sg_actor_self()
-Querying info about actors
---------------------------
+Querying info
+-------------
.. tabs::
.. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
.. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
+ .. autodoxymethod:: sg_actor_is_daemon
.. _API_s4u_Actor_end:
.. autodoxyvar:: simgrid::s4u::Actor::on_creation
.. autodoxyvar:: simgrid::s4u::Actor::on_suspend
+ .. cpp:var:: xbt::signal<void(const Actor&, const Host & previous_location)> Actor::on_host_change
+
+ Signal fired when an actor is migrated from one host to another.
+
.. autodoxyvar:: simgrid::s4u::Actor::on_resume
.. autodoxyvar:: simgrid::s4u::Actor::on_sleep
.. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
.. group-tab:: C++
.. autodoxymethod:: simgrid::s4u::this_actor::exec_async(double flops_amounts)
- .. 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)
+ .. 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)
.. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
.. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
.. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
- .. 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)
- .. 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)
+ .. 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)
+ .. 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)
.. group-tab:: Python
.. automethod:: simgrid.Engine.get_all_hosts
+ .. group-tab:: C
+
+ See also :cpp:func:`sg_host_list` and :cpp:func:`sg_host_count`.
+
Retrieving links
----------------
.. automethod:: simgrid.Mailbox.by_name
Querying info
-.............
+-------------
.. tabs::
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname()
- .. autodoxymethod:: simgrid::s4u::Mailbox::get_name()
+ .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Mailbox::get_name() const
.. group-tab:: Python
.. autoattribute:: simgrid.Mailbox.name
Sending data
-............
+------------
.. tabs::
Receiving data
-..............
+--------------
.. tabs::
.. autodoxymethod:: sg_mailbox_listen(const char *alias)
Receiving actor
-...............
+---------------
See :ref:`s4u_receiving_actor`.
.. group-tab:: C
- .. autodoxymethod:: ::sg_mailbox_set_receiver(const char *alias)
+ .. autodoxymethod:: sg_mailbox_set_receiver(const char *alias)
.. _API_s4u_Resource:
class Disk
=============
-.. doxygenclass:: simgrid::s4u::Disk
- :members:
- :protected-members:
- :undoc-members:
+.. autodoxyclass:: simgrid::s4u::Disk
+Basic management
+----------------
+.. tabs::
-.. _API_s4u_Host:
+ .. group-tab:: C++
-=============
- class Host
-=============
+ .. code-block:: C++
-.. doxygenclass:: simgrid::s4u::Host
- :members:
- :protected-members:
- :undoc-members:
+ #include <simgrid/s4u/Disk.hpp>
-.. _API_s4u_Link:
+ 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.
+
-=============
- class Link
-=============
+Querying info
+-------------
-.. doxygenclass:: simgrid::s4u::Link
- :members:
- :protected-members:
- :undoc-members:
+.. tabs::
-.. _API_s4u_NetZone:
+ .. group-tab:: C++
-================
- class NetZone
-================
+ .. autodoxymethod:: simgrid::s4u::Disk::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_host() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_name() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_properties() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key) const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth() const
+ .. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
-.. doxygenclass:: simgrid::s4u::NetZone
- :members:
- :protected-members:
- :undoc-members:
+I/O operations
+--------------
-.. _API_s4u_VirtualMachine:
+.. tabs::
-=======================
- class VirtualMachine
-=======================
+ .. group-tab:: C++
-.. doxygenclass:: simgrid::s4u::VirtualMachine
- :members:
- :protected-members:
- :undoc-members:
-
-.. autodoxymethod:: sg_vm_create_core
-.. autodoxymethod:: sg_vm_create_multicore
-.. autodoxymethod:: sg_vm_get_name
-.. autodoxymethod:: sg_vm_get_pm
-.. autodoxymethod:: sg_vm_is_created
-.. autodoxymethod:: sg_vm_is_running
-.. autodoxymethod:: sg_vm_is_suspended
-.. autodoxymethod:: sg_vm_start
-.. autodoxymethod:: sg_vm_suspend
-.. autodoxymethod:: sg_vm_resume
-.. autodoxymethod:: sg_vm_shutdown
-.. autodoxymethod:: sg_vm_destroy
+ .. autodoxymethod:: simgrid::s4u::Disk::io_init(sg_size_t size, s4u::Io::OpType type)
+ .. autodoxymethod:: simgrid::s4u::Disk::read(sg_size_t size)
+ .. autodoxymethod:: simgrid::s4u::Disk::read_async(sg_size_t size)
+ .. autodoxymethod:: simgrid::s4u::Disk::write(sg_size_t size)
+ .. autodoxymethod:: simgrid::s4u::Disk::write_async(sg_size_t size)
-.. _API_s4u_Activity:
+Signals
+-------
-==============
-class Activity
-==============
+.. tabs::
-.. autodoxyclass:: simgrid::s4u::Activity
+ .. group-tab:: C++
- **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).
- See also the :ref:`section on activities <s4u_Activities>` above.
+ .. autodoxyvar:: simgrid::s4u::Disk::on_creation
+ .. autodoxyvar:: simgrid::s4u::Disk::on_destruction
+ .. autodoxyvar:: simgrid::s4u::Disk::on_state_change
-Querying info about activities
-------------------------------
- .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
- .. autodoxymethod:: simgrid::s4u::Activity::get_state()
- .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
- .. autodoxymethod:: simgrid::s4u::Activity::get_impl
+.. _API_s4u_Host:
-Activities lifecycle
---------------------
+=============
+ class Host
+=============
- .. autodoxymethod:: simgrid::s4u::Activity::start
- .. autodoxymethod:: simgrid::s4u::Activity::cancel
- .. autodoxymethod:: simgrid::s4u::Activity::test
- .. autodoxymethod:: simgrid::s4u::Activity::wait
- .. autodoxymethod:: simgrid::s4u::Activity::wait_for
- .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
+.. autodoxyclass:: simgrid::s4u::Host
-.. _API_s4u_Comm:
+Basic management
+----------------
-=============
- class Comm
-=============
+.. tabs::
-.. doxygentypedef:: CommPtr
+ .. group-tab:: C++
-.. doxygenclass:: simgrid::s4u::Comm
- :members:
- :protected-members:
- :undoc-members:
+ .. code-block:: C++
-.. _API_s4u_Exec:
+ #include <simgrid/s4u/Host.hpp>
-=============
- class Exec
-=============
+ 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.
-.. doxygentypedef:: ExecPtr
+ .. autodoxymethod:: simgrid::s4u::Host::destroy()
-.. doxygenclass:: simgrid::s4u::Exec
- :members:
- :protected-members:
- :undoc-members:
+ .. group-tab:: Python
-.. _API_s4u_ExecSeq:
+ .. code:: Python
-==================
- class ExecSeq
-==================
+ from simgrid import Host
-.. doxygentypedef:: ExecSeqPtr
+ .. group-tab:: C
-.. doxygenclass:: simgrid::s4u::ExecSeq
- :members:
- :protected-members:
- :undoc-members:
+ .. code:: C
-.. _API_s4u_ExecPar:
+ #include <simgrid/host.h>
-==================
- class ExecPar
-==================
+ .. doxygentypedef:: sg_host_t
+ .. cpp:type:: const s4u_Host* const_sg_host_t
-.. doxygentypedef:: ExecParPtr
+ Pointer to a constant host object.
-.. doxygenclass:: simgrid::s4u::ExecPar
- :members:
- :protected-members:
- :undoc-members:
+Retrieving hosts
+----------------
-.. _API_s4u_Io:
+.. tabs::
-===========
- class Io
-===========
+ .. group-tab:: C++
-.. doxygentypedef:: IoPtr
+ See also :cpp:func:`simgrid::s4u::Engine::get_all_hosts`.
-.. doxygenclass:: simgrid::s4u::Io
- :members:
- :protected-members:
- :undoc-members:
+ .. autodoxymethod:: simgrid::s4u::Host::by_name(const std::string &name)
+ .. autodoxymethod:: simgrid::s4u::Host::by_name_or_null(const std::string &name)
+ .. autodoxymethod:: simgrid::s4u::Host::current()
-.. _API_s4u_Synchronizations:
+ .. group-tab:: Python
-=======================
-Synchronization Objects
-=======================
+ See also :py:func:`simgrid.Engine.get_all_hosts`.
-.. _API_s4u_Mutex:
+ .. automethod:: simgrid.Host.by_name
+ .. automethod:: simgrid.Host.current
-==============
- Mutex
-==============
+ .. group-tab:: C
-.. autodoxyclass:: simgrid::s4u::Mutex
+ .. autodoxymethod:: sg_host_by_name(const char *name)
+ .. autodoxymethod:: sg_host_count()
+ .. autodoxymethod:: sg_host_list()
+ .. autodoxymethod:: sg_hosts_as_dynar()
-Basic management
-----------------
+Querying info
+-------------
- .. tabs::
+.. tabs::
- .. group-tab:: C++
+ .. group-tab:: C++
- .. code-block:: C++
+ .. autodoxymethod:: simgrid::s4u::Host::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_core_count() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_name() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_available_speed() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_load() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_speed() const
- #include <simgrid/s4u/Mutex.hpp>
+ .. group-tab:: Python
- .. doxygentypedef:: MutexPtr
+ .. autoattribute:: simgrid.Host.name
+ .. autoattribute:: simgrid.Host.load
+ .. autoattribute:: simgrid.Host.pstate
+ .. autoattribute:: simgrid.Host.speed
- .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
- .. autodoxymethod:: simgrid::s4u::Mutex::create()
- .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
+ .. group-tab:: C
- .. group-tab:: C
+ .. autodoxymethod:: sg_host_core_count(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_dump(const_sg_host_t ws)
+ .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_load(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_speed(const_sg_host_t host)
- .. code-block:: C
+User data and properties
+------------------------
- #include <simgrid/mutex.h>
+.. tabs::
- .. doxygentypedef:: sg_mutex_t
- .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
+ .. group-tab:: C++
- Pointer to a constant mutex object.
+ .. autodoxymethod:: simgrid::s4u::Host::get_properties() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key) const
+ .. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::map< std::string, std::string > &properties)
+ .. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
- .. autodoxymethod:: sg_mutex_init()
- .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
+ .. group-tab:: C
-Locking
--------
+ .. autodoxymethod:: sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
+ .. autodoxymethod:: sg_host_get_properties(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_get_property_value(const_sg_host_t host, const char *name)
+ .. autodoxymethod:: sg_host_extension_create(void(*deleter)(void *))
+ .. autodoxymethod:: sg_host_extension_get(const_sg_host_t host, size_t rank)
- .. tabs::
+Retrieving components
+---------------------
- .. group-tab:: C++
+.. tabs::
- .. autodoxymethod:: simgrid::s4u::Mutex::lock()
- .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
- .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
+ .. group-tab:: C++
- .. group-tab:: C
+ .. autodoxymethod:: simgrid::s4u::Host::add_disk(Disk *disk)
+ .. autodoxymethod:: simgrid::s4u::Host::get_actor_count() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_all_actors() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_disks() const
+ .. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
- .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
- .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
- .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
+ .. group-tab:: C
-.. _API_s4u_Barrier:
+ .. autodoxymethod:: sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
-================
- Barrier
-================
+On/Off
+------
-.. autodoxyclass:: simgrid::s4u::Barrier
+.. tabs::
- .. tabs::
+ .. group-tab:: C++
- .. group-tab:: C++
+ .. autodoxymethod:: simgrid::s4u::Host::is_on() const
+ .. autodoxymethod:: simgrid::s4u::Host::turn_off()
+ .. autodoxymethod:: simgrid::s4u::Host::turn_on()
- .. code-block:: C++
+ .. group-tab:: C
- #include <simgrid/s4u/Barrier.hpp>
+ .. autodoxymethod:: sg_host_is_on(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_turn_off(sg_host_t host)
+ .. autodoxymethod:: sg_host_turn_on(sg_host_t host)
- .. doxygentypedef:: BarrierPtr
+DVFS
+----
- .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
- .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
- .. autodoxymethod:: simgrid::s4u::Barrier::wait()
+.. tabs::
- .. group-tab:: C
+ .. group-tab:: C++
- .. code-block:: C
+ .. autodoxymethod:: simgrid::s4u::Host::get_pstate() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
+ .. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
+ .. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
+ .. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
- #include <simgrid/barrier.hpp>
+ .. group-tab:: Python
- .. doxygentypedef:: sg_bar_t
- .. cpp:type:: const s4u_Barrier* const_sg_bar_t
+ .. automethod:: simgrid.Host.get_pstate_count
+ .. automethod:: simgrid.Host.get_pstate_speed
- Pointer to a constant barrier object.
+ .. group-tab:: C
- .. autodoxymethod:: sg_barrier_init(unsigned int count)
- .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
- .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
+ .. autodoxymethod:: sg_host_get_available_speed(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_get_nb_pstates(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_get_pstate(const_sg_host_t host)
+ .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
+ .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
+Execution
+---------
-.. _API_s4u_ConditionVariable:
+.. tabs::
-==========================
- Condition variable
-==========================
+ .. group-tab:: C++
-.. autodoxyclass:: simgrid::s4u::ConditionVariable
+ .. autodoxymethod:: simgrid::s4u::Host::exec_async(double flops_amounts)
+ .. autodoxymethod:: simgrid::s4u::Host::execute(double flops)
+ .. autodoxymethod:: simgrid::s4u::Host::execute(double flops, double priority)
-Basic management
-----------------
+Platform and routing
+--------------------
- .. tabs::
+.. tabs::
- .. group-tab:: C++
+ .. group-tab:: C++
- .. code-block:: C++
+ .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
+ .. autodoxymethod:: simgrid::s4u::Host::get_netpoint() const
+ .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link *> &links, double *latency) const
+ .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl *> &links, double *latency) const
+ .. autodoxymethod:: simgrid::s4u::Host::sendto(Host *dest, double byte_amount)
+ .. autodoxymethod:: simgrid::s4u::Host::sendto_async(Host *dest, double byte_amount)
- #include <simgrid/s4u/ConditionVariable.hpp>
+ .. group-tab:: C
- .. doxygentypedef:: ConditionVariablePtr
+ .. autodoxymethod:: sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
+ .. autodoxymethod:: sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
+ .. autodoxymethod:: sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
+ .. autodoxymethod:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
- .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
+Signals
+-------
- .. group-tab:: C
+.. tabs::
- .. code-block:: C
+ .. group-tab:: C++
- #include <simgrid/cond.h>
+ .. autodoxyvar:: simgrid::s4u::Host::on_creation
+ .. autodoxyvar:: simgrid::s4u::Host::on_destruction
+ .. autodoxyvar:: simgrid::s4u::Host::on_speed_change
+ .. autodoxyvar:: simgrid::s4u::Host::on_state_change
- .. doxygentypedef:: sg_cond_t
- .. doxygenfunction:: sg_cond_init
- .. doxygenfunction:: sg_cond_destroy
+.. _API_s4u_Link:
-Waiting and notifying
----------------------
+=============
+ class Link
+=============
- .. tabs::
+.. autodoxyclass:: simgrid::s4u::Link
- .. group-tab:: C++
+Basic management
+----------------
- .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
- .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
- .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
- .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Link.hpp>
+
+ 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.
+
+ .. group-tab:: Python
+
+ .. code:: Python
+
+ from simgrid import Link
+
+ .. group-tab:: C
+
+ .. code:: C
+
+ #include <simgrid/link.h>
+
+ .. doxygentypedef:: sg_link_t
+ .. cpp:type:: const s4u_Link* const_sg_link_t
+
+ Pointer to a constant link object.
+
+Retrieving links
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ See also :cpp:func:`simgrid::s4u::Engine::get_all_links`.
+
+ .. autodoxymethod:: simgrid::s4u::Link::by_name(const std::string &name)
+ .. autodoxymethod:: simgrid::s4u::Link::by_name_or_null(const std::string &name)
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_link_by_name(const char *name)
+ .. autodoxymethod:: sg_link_count()
+ .. autodoxymethod:: sg_link_list()
+
+Querying info
+--------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_latency() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_name() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_usage() const
+ .. autodoxymethod:: simgrid::s4u::Link::is_used() const
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_link_bandwidth(const_sg_link_t link)
+ .. autodoxymethod:: sg_link_is_shared(const_sg_link_t link)
+ .. autodoxymethod:: sg_link_latency(const_sg_link_t link)
+ .. autodoxymethod:: sg_link_name(const_sg_link_t link)
+
+User data and properties
+------------------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key) const
+ .. autodoxymethod:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_link_data(const_sg_link_t link)
+ .. autodoxymethod:: sg_link_data_set(sg_link_t link, void *data)
+
+On/Off
+------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
+
+ .. autodoxymethod:: simgrid::s4u::Link::is_on() const
+ .. autodoxymethod:: simgrid::s4u::Link::turn_off()
+ .. autodoxymethod:: simgrid::s4u::Link::turn_on()
+
+Dynamic profiles
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth_profile(kernel::profile::Profile *profile)
+ .. autodoxymethod:: simgrid::s4u::Link::set_latency_profile(kernel::profile::Profile *profile)
+ .. autodoxymethod:: simgrid::s4u::Link::set_state_profile(kernel::profile::Profile *profile)
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxyvar:: simgrid::s4u::Link::on_bandwidth_change
+ .. cpp:var:: xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> Link::on_communicate
+ .. autodoxyvar:: simgrid::s4u::Link::on_communication_state_change
+ .. autodoxyvar:: simgrid::s4u::Link::on_creation
+ .. autodoxyvar:: simgrid::s4u::Link::on_destruction
+ .. autodoxyvar:: simgrid::s4u::Link::on_state_change
+
+.. _API_s4u_NetZone:
+
+================
+ class NetZone
+================
+
+.. autodoxyclass:: simgrid::s4u::NetZone
+
+Basic management
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/NetZone.hpp>
+
+ 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.
+
+ .. group-tab:: C
+
+ .. code:: C
+
+ #include <simgrid/zone.h>
+
+ .. doxygentypedef:: sg_netzone_t
+ .. cpp:type:: const s4u_NetZone* const_sg_netzone_t
+
+ Pointer to a constant network zone object.
+
+Retrieving zones
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ See :cpp:func:`simgrid::s4u::Engine::get_netzone_root`,
+ :cpp:func:`simgrid::s4u::Engine::netzone_by_name_or_null` and
+ :cpp:func:`simgrid::s4u::Engine::get_filtered_netzones`.
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_zone_get_by_name(const char *name)
+ .. autodoxymethod:: sg_zone_get_root()
+
+Querying info
+--------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_name() const
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_zone_get_name(const_sg_netzone_t zone)
+
+User data and properties
+------------------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_properties() const
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key) const
+ .. autodoxymethod:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
+ .. autodoxymethod:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
+
+Retrieving components
+---------------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts() const
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count() const
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
+
+Routing data
+------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. 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)
+ .. autodoxymethod:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
+ .. 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)
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_children() const
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_father()
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxyvar:: simgrid::s4u::NetZone::on_creation
+ .. autodoxyvar:: simgrid::s4u::NetZone::on_route_creation
+ .. autodoxyvar:: simgrid::s4u::NetZone::on_seal
+
+.. _API_s4u_VirtualMachine:
+
+=======================
+ class VirtualMachine
+=======================
+
+
+.. autodoxyclass:: simgrid::s4u::VirtualMachine
+
+Basic management
+----------------
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/VirtualMachine.hpp>
+
+ Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
+ idiom on virtual machines. There is no good reason for that and should change in the future.
+
+ .. group-tab:: C
+
+ .. code:: C
+
+ #include <simgrid/vm.h>
+
+ .. doxygentypedef:: sg_vm_t
+ .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
+
+ Pointer to a constant virtual machine object.
+
+Creating VMs
+------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::destroy
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_vm_create_core
+ .. autodoxymethod:: sg_vm_create_multicore
+ .. autodoxymethod:: sg_vm_destroy
+
+Querying info
+--------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_pm() const
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_ramsize() const
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_state()
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_bound(double bound)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_vm_get_ramsize(const_sg_vm_t vm)
+ .. autodoxymethod:: sg_vm_set_bound(sg_vm_t vm, double bound)
+ .. autodoxymethod:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
+
+ .. autodoxymethod:: sg_vm_get_name
+ .. autodoxymethod:: sg_vm_get_pm
+ .. autodoxymethod:: sg_vm_is_created
+ .. autodoxymethod:: sg_vm_is_running
+ .. autodoxymethod:: sg_vm_is_suspended
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::resume()
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::shutdown()
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::start()
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::suspend()
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_vm_start
+ .. autodoxymethod:: sg_vm_suspend
+ .. autodoxymethod:: sg_vm_resume
+ .. autodoxymethod:: sg_vm_shutdown
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_end
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_start
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_resume
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_shutdown
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_start
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_started
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_suspend
+
+.. _API_s4u_Activity:
+
+==============
+class Activity
+==============
+
+.. autodoxyclass:: simgrid::s4u::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).
+ See also the :ref:`section on activities <s4u_Activities>` above.
+
+Basic management
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Activity.hpp>
+
+ .. doxygentypedef:: ActivityPtr
+
+Querying info
+-------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Activity::get_cname
+ .. autodoxymethod:: simgrid::s4u::Activity::get_name
+ .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() const
+ .. autodoxymethod:: simgrid::s4u::Activity::get_state() const
+ .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
+ .. autodoxymethod:: simgrid::s4u::Activity::set_state(Activity::State state)
+
+
+Activities life cycle
+---------------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Activity::start
+ .. autodoxymethod:: simgrid::s4u::Activity::cancel
+ .. autodoxymethod:: simgrid::s4u::Activity::test
+ .. autodoxymethod:: simgrid::s4u::Activity::wait
+ .. autodoxymethod:: simgrid::s4u::Activity::wait_for
+ .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
+ .. autodoxymethod:: simgrid::s4u::Activity::vetoable_start()
+
+.. _API_s4u_Comm:
+
+=============
+ class Comm
+=============
+
+.. autodoxyclass:: simgrid::s4u::Comm
+
+Basic management
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Comm.hpp>
+
+ .. doxygentypedef:: CommPtr
+
+ .. group-tab:: Python
+
+ .. code:: Python
+
+ from simgrid import Comm
+
+Querying info
+-------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Comm::get_dst_data_size() const
+ .. autodoxymethod:: simgrid::s4u::Comm::get_mailbox() const
+ .. autodoxymethod:: simgrid::s4u::Comm::get_sender() const
+ .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
+ .. autodoxymethod:: simgrid::s4u::Comm::detach()
+ .. autodoxymethod:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
+ .. autodoxymethod:: simgrid::s4u::Comm::set_rate(double rate)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_src_data_size(size_t size)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_tracing_category(const std::string &category)
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Comm::cancel
+ .. autodoxymethod:: simgrid::s4u::Comm::start
+ .. autodoxymethod:: simgrid::s4u::Comm::test
+ .. autodoxymethod:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr > *comms)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr > *comms)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr > *comms)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr > *comms_in, double timeout)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_for
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Comm.test
+ .. automethod:: simgrid.Comm.wait
+ .. automethod:: simgrid.Comm.wait_all
+ .. automethod:: simgrid.Comm.wait_any
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxyvar:: simgrid::s4u::Comm::on_completion
+ .. autodoxyvar:: simgrid::s4u::Comm::on_receiver_start
+ .. autodoxyvar:: simgrid::s4u::Comm::on_sender_start
+
+.. _API_s4u_Exec:
+
+=============
+ class Exec
+=============
+
+.. autodoxyclass:: simgrid::s4u::Exec
+
+Basic management
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Exec.hpp>
+
+ .. doxygentypedef:: ExecPtr
+
+ .. group-tab:: Python
+
+ .. code:: Python
+
+ from simgrid import Exec
+
+Querying info
+-------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Exec::get_cost() const
+ .. autodoxymethod:: simgrid::s4u::Exec::get_finish_time() const
+ .. autodoxymethod:: simgrid::s4u::Exec::get_host() const
+ .. autodoxymethod:: simgrid::s4u::Exec::get_host_number() const
+ .. cpp:function:: double Exec::get_remaining()
+
+ On sequential executions, returns the amount of flops that remain to be done;
+ This cannot be used on parallel executions.
+
+ .. autodoxymethod:: simgrid::s4u::Exec::get_remaining_ratio
+ .. autodoxymethod:: simgrid::s4u::Exec::get_start_time() const
+ .. autodoxymethod:: simgrid::s4u::Exec::set_bound(double bound)
+ .. autodoxymethod:: simgrid::s4u::Exec::set_host
+ .. autodoxymethod:: simgrid::s4u::Exec::set_priority(double priority)
+
+ .. group-tab:: Python
+
+ .. autoattribute:: simgrid.Exec.host
+ .. autoattribute:: simgrid.Exec.remaining
+ .. autoattribute:: simgrid.Exec.remaining_ratio
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Exec::cancel
+ .. autodoxymethod:: simgrid::s4u::Exec::set_timeout(double timeout)
+ .. autodoxymethod:: simgrid::s4u::Exec::start
+ .. autodoxymethod:: simgrid::s4u::Exec::test
+ .. autodoxymethod:: simgrid::s4u::Exec::wait
+ .. autodoxymethod:: simgrid::s4u::Exec::wait_any(std::vector< ExecPtr > *execs)
+ .. autodoxymethod:: simgrid::s4u::Exec::wait_any_for(std::vector< ExecPtr > *execs, double timeout)
+ .. autodoxymethod:: simgrid::s4u::Exec::wait_for
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Exec.cancel
+ .. automethod:: simgrid.Exec.start
+ .. automethod:: simgrid.Exec.test
+ .. automethod:: simgrid.Exec.wait
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion
+ .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_start
+
+.. _API_s4u_Io:
+
+===========
+ class Io
+===========
+
+.. autodoxyclass:: simgrid::s4u::Io
+
+Basic management
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Io.hpp>
+
+ .. doxygentypedef:: IoPtr
+
+Querying info
+-------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Io::get_performed_ioops() const
+ .. autodoxymethod:: simgrid::s4u::Io::get_remaining
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Io::cancel
+ .. autodoxymethod:: simgrid::s4u::Io::start
+ .. autodoxymethod:: simgrid::s4u::Io::test
+ .. autodoxymethod:: simgrid::s4u::Io::wait
+ .. autodoxymethod:: simgrid::s4u::Io::wait_for
+
+.. _API_s4u_Synchronizations:
+
+=======================
+Synchronization Objects
+=======================
+
+.. _API_s4u_Mutex:
+
+==============
+ Mutex
+==============
+
+.. autodoxyclass:: simgrid::s4u::Mutex
+
+Basic management
+----------------
+
+ .. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Mutex.hpp>
+
+ .. doxygentypedef:: MutexPtr
+
+ .. autodoxymethod:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex)
+ .. autodoxymethod:: simgrid::s4u::Mutex::create()
+ .. autodoxymethod:: simgrid::s4u::Mutex::~Mutex()
+
+ .. group-tab:: C
+
+ .. code-block:: C
+
+ #include <simgrid/mutex.h>
+
+ .. doxygentypedef:: sg_mutex_t
+ .. cpp:type:: const s4u_Mutex* const_sg_mutex_t
+
+ Pointer to a constant mutex object.
+
+ .. autodoxymethod:: sg_mutex_init()
+ .. autodoxymethod:: sg_mutex_destroy(const_sg_mutex_t mutex)
+
+Locking
+-------
+
+ .. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Mutex::lock()
+ .. autodoxymethod:: simgrid::s4u::Mutex::try_lock()
+ .. autodoxymethod:: simgrid::s4u::Mutex::unlock()
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_mutex_lock(sg_mutex_t mutex)
+ .. autodoxymethod:: sg_mutex_try_lock(sg_mutex_t mutex)
+ .. autodoxymethod:: sg_mutex_unlock(sg_mutex_t mutex)
+
+.. _API_s4u_Barrier:
+
+================
+ Barrier
+================
+
+.. autodoxyclass:: simgrid::s4u::Barrier
+
+ .. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Barrier.hpp>
+
+ .. doxygentypedef:: BarrierPtr
+
+ .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
+ .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
+ .. autodoxymethod:: simgrid::s4u::Barrier::wait()
+
+ .. group-tab:: C
+
+ .. code-block:: C
+
+ #include <simgrid/barrier.hpp>
+
+ .. doxygentypedef:: sg_bar_t
+ .. cpp:type:: const s4u_Barrier* const_sg_bar_t
+
+ Pointer to a constant barrier object.
+
+ .. autodoxymethod:: sg_barrier_init(unsigned int count)
+ .. autodoxymethod:: sg_barrier_destroy(const_sg_bar_t bar)
+ .. autodoxymethod:: sg_barrier_wait(sg_bar_t bar)
+
+
+.. _API_s4u_ConditionVariable:
+
+==========================
+ Condition variable
+==========================
+
+.. autodoxyclass:: simgrid::s4u::ConditionVariable
+
+Basic management
+----------------
+
+ .. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/ConditionVariable.hpp>
+
+ .. doxygentypedef:: ConditionVariablePtr
+
+ .. autodoxymethod:: simgrid::s4u::ConditionVariable::create()
+
+ .. group-tab:: C
+
+ .. code-block:: C
+
+ #include <simgrid/cond.h>
+
+ .. doxygentypedef:: sg_cond_t
+ .. autodoxymethod:: sg_cond_init
+ .. autodoxymethod:: sg_cond_destroy
+
+Waiting and notifying
+---------------------
+
+ .. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_all()
+ .. autodoxymethod:: simgrid::s4u::ConditionVariable::notify_one()
+ .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(s4u::MutexPtr lock)
+ .. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< s4u::Mutex > &lock)
.. autodoxymethod:: simgrid::s4u::ConditionVariable::wait(const std::unique_lock< Mutex > &lock, P pred)
.. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration)
.. autodoxymethod:: simgrid::s4u::ConditionVariable::wait_for(const std::unique_lock< s4u::Mutex > &lock, double duration, P pred)
.. group-tab:: C
- .. doxygenfunction:: sg_cond_notify_all
- .. doxygenfunction:: sg_cond_notify_one
- .. doxygenfunction:: sg_cond_wait
- .. doxygenfunction:: sg_cond_wait_for
+ .. autodoxymethod:: sg_cond_notify_all
+ .. autodoxymethod:: sg_cond_notify_one
+ .. autodoxymethod:: sg_cond_wait
+ .. autodoxymethod:: sg_cond_wait_for
.. _API_s4u_Semaphore:
.. autodoxymethod:: sg_sem_release(sg_sem_t sem)
.. autodoxymethod:: sg_sem_would_block(sg_sem_t sem)
-Python API Reference
-********************
-
-The Python API is automatically generated with pybind11. It closely mimicks the C++
-API, to which you should refer for more information.
-
-==========
-this_actor
-==========
-
-.. automodule:: simgrid.this_actor
- :members:
-
-==========
-Class Comm
-==========
-
-.. autoclass:: simgrid.Comm
- :members:
-
-==========
-Class Exec
-==========
-
-.. autoclass:: simgrid.Exec
- :members:
-
-==========
-Class Host
-==========
-
-.. autoclass:: simgrid.Host
- :members:
-
-=============
-Class Mailbox
-=============
-
-.. autoclass:: simgrid.Mailbox
- :members:
-
.. |hr| raw:: html
<hr />