#include "simgrid/kernel/ProfileBuilder.hpp"
#include "simgrid/kernel/routing/NetPoint.hpp"
-#include "src/kernel/context/Context.hpp"
#include <simgrid/Exception.hpp>
#include <simgrid/s4u/Actor.hpp>
#include <simgrid/s4u/Comm.hpp>
py::register_exception<simgrid::NetworkFailureException>(m, "NetworkFailureException");
py::register_exception<simgrid::TimeoutException>(m, "TimeoutException");
+ py::register_exception<simgrid::HostFailureException>(m, "HostFailureException");
+ py::register_exception<simgrid::StorageFailureException>(m, "StorageFailureException");
+ py::register_exception<simgrid::VmFailureException>(m, "VmFailureException");
+ py::register_exception<simgrid::CancelException>(m, "CancelException");
/* this_actor namespace */
m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.")
"debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.")
.def(
"info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
+ .def(
+ "warning", [](const char* s) { XBT_WARN("%s", s); }, "Display a logging message of 'warning' priority.")
.def(
"error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
[](py::object cb) {
py::function fun = py::reinterpret_borrow<py::function>(cb);
fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
- simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
+ simgrid::s4u::this_actor::on_exit([fun](bool failed) {
+ py::gil_scoped_acquire py_context; // need a new context for callback
try {
- py::gil_scoped_acquire py_context; // need a new context for callback
- fun();
+ fun(failed);
} catch (const py::error_already_set& e) {
xbt_die("Error while executing the on_exit lambda: %s", e.what());
}
});
},
- py::call_guard<py::gil_scoped_release>(), "")
+ py::call_guard<py::gil_scoped_release>(),
+ "Define a lambda to be called when the actor ends. It takes a bool parameter indicating whether the actor "
+ "was killed. If False, the actor finished peacefully.")
.def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
.def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
"Retrieves PPID of the current actor (i.e., the PID of its parent).");
}),
"The constructor should take the parameters from the command line, as is ")
.def_static("get_clock",
- [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v333
+ []() // XBT_ATTRIB_DEPRECATED_v334
{
- PyErr_WarnEx(PyExc_DeprecationWarning,
- "get_clock() is deprecated and will be dropped after v3.32, use clock() instead.", 1);
- return self.attr("clock");
+ PyErr_WarnEx(
+ PyExc_DeprecationWarning,
+ "get_clock() is deprecated and will be dropped after v3.33, use `Engine.clock` instead.", 1);
+ return Engine::get_clock();
})
- .def_static("clock", &Engine::get_clock,
- "The simulation time, ie the amount of simulated seconds since the simulation start.")
- .def_static(
- "instance", []() { return Engine::get_instance(); }, "Retrieve the simulation engine")
+ .def_property_readonly_static(
+ "clock", [](py::object /* self */) { return Engine::get_clock(); },
+ "The simulation time, ie the amount of simulated seconds since the simulation start.")
+ .def_property_readonly_static(
+ "instance", [](py::object /* self */) { return Engine::get_instance(); }, "Retrieve the simulation engine")
.def("get_all_hosts",
- [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v333
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
{
PyErr_WarnEx(PyExc_DeprecationWarning,
- "get_all_hosts() is deprecated and will be dropped after v3.32, use all_host() instead.", 1);
+ "get_all_hosts() is deprecated and will be dropped after v3.33, use all_hosts instead.", 1);
return self.attr("all_hosts");
})
.def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
.def("get_all_links",
- [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v333
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
{
PyErr_WarnEx(PyExc_DeprecationWarning,
- "get_all_links() is deprecated and will be dropped after v3.32, use all_links() instead.",
- 1);
+ "get_all_links() is deprecated and will be dropped after v3.33, use all_links instead.", 1);
return self.attr("all_links");
})
.def_property_readonly("all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
.def("get_all_netpoints",
- [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v333
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
{
PyErr_WarnEx(
PyExc_DeprecationWarning,
- "get_all_netpoints() is deprecated and will be dropped after v3.32, use all_netpoints() instead.", 1);
+ "get_all_netpoints() is deprecated and will be dropped after v3.33, use all_netpoints instead.", 1);
return self.attr("all_netpoints");
})
.def_property_readonly("all_netpoints", &Engine::get_all_netpoints)
.def("get_netzone_root",
- [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v333
- {
- PyErr_WarnEx(
- PyExc_DeprecationWarning,
- "get_netzone_root() is deprecated and will be dropped after v3.32, use netzone_root() instead.", 1);
- return self.attr("netzone_root");
- })
- .def("set_netzone_root",
- [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v333
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
{
PyErr_WarnEx(PyExc_DeprecationWarning,
- "set_netzone_root() is deprecated and will be dropped after v3.32.", 1);
+ "get_netzone_root() is deprecated and will be dropped after v3.3, use netzone_root instead.",
+ 1);
+ return self.attr("netzone_root");
})
.def_property_readonly("netzone_root", &Engine::get_netzone_root,
"Retrieve the root netzone, containing all others.")
"register_actor",
[](Engine* e, const std::string& name, py::object fun_or_class) {
e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
+ py::gil_scoped_acquire py_context;
try {
- py::gil_scoped_acquire py_context;
/* Convert the std::vector into a py::tuple */
py::tuple params(args.size() - 1);
for (size_t i = 1; i < args.size(); i++)
.def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
.def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
.def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
- .def("get_netpoint", &simgrid::s4u::NetZone::get_netpoint, "Retrieve the netpoint associated to this zone")
+ .def("get_netpoint",
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(PyExc_DeprecationWarning,
+ "get_netpoint() is deprecated and will be dropped after v3.33, use netpoint instead.", 1);
+ return self.attr("netpoint");
+ })
+ .def_property_readonly("netpoint", &simgrid::s4u::NetZone::get_netpoint,
+ "Retrieve the netpoint associated to this zone")
.def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
.def_property_readonly(
"name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); },
/* Class Host */
py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
m, "Host", "Simulated host. See the C++ documentation for details.");
- host.def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
+ host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die")
.def(
"route_to",
[](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
" \"\"\"\n\n"
"The second function parameter is the periodicity: the time to wait after the last event to start again over "
"the list. Set it to -1 to not loop over.")
- .def("get_pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
- .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
- .def("get_netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this host")
+ .def("get_pstate_count",
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(
+ PyExc_DeprecationWarning,
+ "get_pstate_count() is deprecated and will be dropped after v3.33, use pstate_count instead.", 1);
+ return self.attr("pstate_count");
+ })
+ .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
+ .def("get_pstate_speed",
+ [](py::object self, int state) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(
+ PyExc_DeprecationWarning,
+ "get_pstate_speed() is deprecated and will be dropped after v3.33, use pstate_speed instead.", 1);
+ return self.attr("pstate_speed")(state);
+ })
+ .def("pstate_speed", &Host::get_pstate_speed, py::call_guard<py::gil_scoped_release>(),
+ "Retrieve the maximal speed at the given pstate")
+ .def("get_netpoint",
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(PyExc_DeprecationWarning,
+ "get_netpoint() is deprecated and will be dropped after v3.33, use netpoint instead.", 1);
+ return self.attr("netpoint");
+ })
+ .def_property_readonly("netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this zone")
.def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
- .def("set_core_count", &Host::set_core_count, py::call_guard<py::gil_scoped_release>(),
- "Set the number of cores in the CPU")
+ .def("set_core_count",
+ [](py::object self, double count) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(PyExc_DeprecationWarning,
+ "set_core_count() is deprecated and will be dropped after v3.33, use core_count instead.",
+ 1);
+ self.attr("core_count")(count);
+ })
+ .def_property(
+ "core_count", &Host::get_core_count,
+ [](Host* h, int count) {
+ py::gil_scoped_release gil_guard;
+ return h->set_core_count(count);
+ },
+ "Manage the number of cores in the CPU")
.def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
"Set the coordinates of this host")
.def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
h->set_pstate(i);
},
"The current pstate (read/write property).")
- .def("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
+ .def
_static("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
"Retrieves the host on which the running actor is located.")
.def_property_readonly(
"name",
"Get the available speed ratio, between 0 and 1.\n"
"This accounts for external load (see :py:func:`set_speed_profile() "
"<simgrid.Host.set_speed_profile>`) (read-only property).")
- .def(
+ .def_static(
"on_creation_cb",
[](py::object cb) {
Host::on_creation_cb([cb](Host& h) {
py::function fun = py::reinterpret_borrow<py::function>(cb);
+ py::gil_scoped_acquire py_context; // need a new context for callback
try {
- py::gil_scoped_acquire py_context; // need a new context for callback
fun(&h);
} catch (const py::error_already_set& e) {
xbt_die("Error while executing the on_creation lambda : %s", e.what());
/* Class Split-Duplex Link */
py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
m, "SplitDuplexLink", "Network split-duplex link")
- .def("get_link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
- .def("get_link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
+ .def("get_link_up",
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(PyExc_DeprecationWarning,
+ "get_link_up() is deprecated and will be dropped after v3.33, use link_up instead.", 1);
+ return self.attr("link_up");
+ })
+ .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
+ .def("get_link_down",
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(PyExc_DeprecationWarning,
+ "get_link_down() is deprecated and will be dropped after v3.33, use link_down instead.", 1);
+ return self.attr("link_down");
+ })
+ .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
/* Class Mailbox */
py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
.def(
"__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
"Textual representation of the Mailbox`")
- .def("by_name", &Mailbox::by_name, py::call_guard<py::gil_scoped_release>(), "Retrieve a Mailbox from its name")
+ .def_static("by_name", &Mailbox::by_name,
+ py::call_guard<py::gil_scoped_release>(),
+ py::arg("name"),
+ "Retrieve a Mailbox from its name")
.def_property_readonly(
"name",
[](const Mailbox* self) {
return self->put_async(data.ptr(), size);
},
py::call_guard<py::gil_scoped_release>(), "Non-blocking data transmission")
+ .def(
+ "put_init",
+ [](Mailbox* self, py::object data, int size) {
+ data.inc_ref();
+ return self->put_init(data.ptr(), size);
+ },
+ py::call_guard<py::gil_scoped_release>(),
+ "Creates (but don’t start) a data transmission to that mailbox.")
.def(
"get",
[](Mailbox* self) {
- py::object data = py
bind11::reinterpret_steal<py::object>(self->get<PyObject>());
+ py::object data = py::reinterpret_steal<py::object>(self->get<PyObject>());
// data.dec_ref(); // FIXME: why does it break python-actor-create?
return data;
},
"Test whether the communication is terminated.")
.def("wait", &simgrid::s4u::Comm::wait, py::call_guard<py::gil_scoped_release>(),
"Block until the completion of that communication.")
+ .def("wait_for", &simgrid::s4u::Comm::wait_for,
+ py::arg("timeout"),
+ py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of that communication, or raises TimeoutException after the specified timeout.")
+ .def("detach", [](simgrid::s4u::Comm* self) {
+ return self->detach();
+ },
+ py::return_value_policy::reference_internal,
+ py::call_guard<py::gil_scoped_release>(),
+ "Start the comm, and ignore its result. It can be completely forgotten after that.")
// use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
.def_static(
"wait_all", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
- py::call_guard<py::gil_scoped_release>(), "Block until the completion of all communications in the list.")
+ py::arg("comms"),
+ py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of all communications in the list.")
+ .def_static("wait_all_for", &simgrid::s4u::Comm::wait_all_for,
+ py::arg("comms"), py::arg("timeout"),
+ py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of all communications in the list, or raises TimeoutException after "
+ "the specified timeout.")
.def_static(
"wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
+ py::arg("comms"),
+ py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of any communication in the list and return the index of the terminated one.")
+ .def_static(
+ "wait_any_for",
+ py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&, double>(&simgrid::s4u::Comm::wait_any_for),
+ py::arg("comms"), py::arg("timeout"),
py::call_guard<py::gil_scoped_release>(),
- "Block until the completion of any communication in the list and return the index of the terminated one.");
+ "Block until the completion of any communication in the list and return the index of the terminated "
+ "one, or -1 if a timeout occurred."
+ );
/* Class Io */
py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities. See the C++ documentation for details.")
fun.inc_ref(); // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
return simgrid::s4u::Actor::create(name, h, [fun, args]() {
+ py::gil_scoped_acquire py_context;
try {
- py::gil_scoped_acquire py_context;
fun(*args);
} catch (const py::error_already_set& ex) {
if (ex.matches(pyForcefulKillEx)) {
.def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).")
.def_property_readonly("ppid", &Actor::get_ppid,
"The PID (unique identifier) of the actor that created this one (read-only property).")
- .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
+ .def_static("by_pid", &Actor::by_pid, py::arg("pid"), "Retrieve an actor by its PID")
.def("set_auto_restart", &Actor::set_auto_restart, py::call_guard<py::gil_scoped_release>(),
"Specify whether the actor shall restart when its host reboots.")
.def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
.def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
"Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
.def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
- .def("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "Kill all actors but the caller.")
.def("self", &Actor::self, "Retrieves the current actor.")
.def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
.def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
"Suspend that actor, that is blocked until resume()ed by another actor.")
.def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
- "Resume that actor, that was previously suspend()ed.");
+ "Resume that actor, that was previously suspend()ed.")
+ .def_static("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "Kill all actors but the caller.");
}
