X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3c19254bcc639fa7d14122d705a6bf977411137f..91fe7904c884b2d0f5e7408d6e9d1d99886bd365:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 81ca2895b1..0b1721b134 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -24,7 +24,6 @@ #include "simgrid/kernel/ProfileBuilder.hpp" #include "simgrid/kernel/routing/NetPoint.hpp" -#include "src/kernel/context/Context.hpp" #include #include #include @@ -89,6 +88,10 @@ PYBIND11_MODULE(simgrid, m) py::register_exception(m, "NetworkFailureException"); py::register_exception(m, "TimeoutException"); + py::register_exception(m, "HostFailureException"); + py::register_exception(m, "StorageFailureException"); + py::register_exception(m, "VmFailureException"); + py::register_exception(m, "CancelException"); /* this_actor namespace */ m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.") @@ -96,6 +99,8 @@ PYBIND11_MODULE(simgrid, m) "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(&simgrid::s4u::this_actor::execute), @@ -122,16 +127,18 @@ PYBIND11_MODULE(simgrid, m) [](py::object cb) { py::function fun = py::reinterpret_borrow(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::call_guard(), + "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)."); @@ -147,11 +154,12 @@ PYBIND11_MODULE(simgrid, m) }), "The constructor should take the parameters from the command line, as is ") .def_static("get_clock", - [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + []() // XBT_ATTRIB_DEPRECATED_v334 { - PyErr_WarnEx(PyExc_DeprecationWarning, - "get_clock() is deprecated and will be dropped after v3.33, 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_property_readonly_static( "clock", [](py::object /* self */) { return Engine::get_clock(); }, @@ -159,7 +167,7 @@ PYBIND11_MODULE(simgrid, m) .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_v334 + [](py::object self) // XBT_ATTRIB_DEPRECATED_v334 { PyErr_WarnEx(PyExc_DeprecationWarning, "get_all_hosts() is deprecated and will be dropped after v3.33, use all_hosts instead.", 1); @@ -167,7 +175,7 @@ PYBIND11_MODULE(simgrid, m) }) .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_v334 + [](py::object self) // XBT_ATTRIB_DEPRECATED_v334 { PyErr_WarnEx(PyExc_DeprecationWarning, "get_all_links() is deprecated and will be dropped after v3.33, use all_links instead.", 1); @@ -175,7 +183,7 @@ PYBIND11_MODULE(simgrid, m) }) .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_v334 + [](py::object self) // XBT_ATTRIB_DEPRECATED_v334 { PyErr_WarnEx( PyExc_DeprecationWarning, @@ -184,7 +192,7 @@ PYBIND11_MODULE(simgrid, m) }) .def_property_readonly("all_netpoints", &Engine::get_all_netpoints) .def("get_netzone_root", - [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + [](py::object self) // XBT_ATTRIB_DEPRECATED_v334 { PyErr_WarnEx(PyExc_DeprecationWarning, "get_netzone_root() is deprecated and will be dropped after v3.3, use netzone_root instead.", @@ -205,8 +213,8 @@ PYBIND11_MODULE(simgrid, m) "register_actor", [](Engine* e, const std::string& name, py::object fun_or_class) { e->register_actor(name, [fun_or_class](std::vector 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++) @@ -277,7 +285,7 @@ PYBIND11_MODULE(simgrid, m) .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", - [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + [](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); @@ -309,7 +317,7 @@ PYBIND11_MODULE(simgrid, m) /* Class Host */ py::class_> 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) { @@ -356,7 +364,7 @@ PYBIND11_MODULE(simgrid, m) "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", - [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + [](py::object self) // XBT_ATTRIB_DEPRECATED_v334 { PyErr_WarnEx( PyExc_DeprecationWarning, @@ -365,7 +373,7 @@ PYBIND11_MODULE(simgrid, m) }) .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels") .def("get_pstate_speed", - [](pybind11::object& self, int state) // XBT_ATTRIB_DEPRECATED_v334 + [](py::object self, int state) // XBT_ATTRIB_DEPRECATED_v334 { PyErr_WarnEx( PyExc_DeprecationWarning, @@ -375,7 +383,7 @@ PYBIND11_MODULE(simgrid, m) .def("pstate_speed", &Host::get_pstate_speed, py::call_guard(), "Retrieve the maximal speed at the given pstate") .def("get_netpoint", - [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + [](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); @@ -384,7 +392,7 @@ PYBIND11_MODULE(simgrid, m) .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", - [](pybind11::object& self, double count) // XBT_ATTRIB_DEPRECATED_v334 + [](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.", @@ -415,7 +423,7 @@ PYBIND11_MODULE(simgrid, m) h->set_pstate(i); }, "The current pstate (read/write property).") - .def("current", &Host::current, py::call_guard(), + .def_static("current", &Host::current, py::call_guard(), "Retrieves the host on which the running actor is located.") .def_property_readonly( "name", @@ -434,13 +442,13 @@ PYBIND11_MODULE(simgrid, m) "Get the available speed ratio, between 0 and 1.\n" "This accounts for external load (see :py:func:`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(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()); @@ -596,7 +604,7 @@ PYBIND11_MODULE(simgrid, m) py::class_>( m, "SplitDuplexLink", "Network split-duplex link") .def("get_link_up", - [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + [](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); @@ -604,7 +612,7 @@ PYBIND11_MODULE(simgrid, m) }) .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up") .def("get_link_down", - [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + [](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); @@ -618,7 +626,10 @@ PYBIND11_MODULE(simgrid, m) .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(), "Retrieve a Mailbox from its name") + .def_static("by_name", &Mailbox::by_name, + py::call_guard(), + py::arg("name"), + "Retrieve a Mailbox from its name") .def_property_readonly( "name", [](const Mailbox* self) { @@ -646,10 +657,18 @@ PYBIND11_MODULE(simgrid, m) return self->put_async(data.ptr(), size); }, py::call_guard(), "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(), + "Creates (but don’t start) a data transmission to that mailbox.") .def( "get", [](Mailbox* self) { - py::object data = pybind11::reinterpret_steal(self->get()); + py::object data = py::reinterpret_steal(self->get()); // data.dec_ref(); // FIXME: why does it break python-actor-create? return data; }, @@ -681,14 +700,40 @@ PYBIND11_MODULE(simgrid, m) "Test whether the communication is terminated.") .def("wait", &simgrid::s4u::Comm::wait, py::call_guard(), "Block until the completion of that communication.") + .def("wait_for", &simgrid::s4u::Comm::wait_for, + py::arg("timeout"), + py::call_guard(), + "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(), + "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&>(&simgrid::s4u::Comm::wait_all), - py::call_guard(), "Block until the completion of all communications in the list.") + py::arg("comms"), + py::call_guard(), + "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(), + "Block until the completion of all communications in the list, or raises TimeoutException after " + "the specified timeout.") .def_static( "wait_any", py::overload_cast&>(&simgrid::s4u::Comm::wait_any), + py::arg("comms"), + py::call_guard(), + "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&, double>(&simgrid::s4u::Comm::wait_any_for), + py::arg("comms"), py::arg("timeout"), py::call_guard(), - "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_(m, "Io", "I/O activities. See the C++ documentation for details.") @@ -739,8 +784,8 @@ PYBIND11_MODULE(simgrid, m) 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)) { @@ -769,7 +814,7 @@ PYBIND11_MODULE(simgrid, m) .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(), "Specify whether the actor shall restart when its host reboots.") .def("daemonize", &Actor::daemonize, py::call_guard(), @@ -781,11 +826,11 @@ PYBIND11_MODULE(simgrid, m) .def("join", py::overload_cast(&Actor::join, py::const_), py::call_guard(), "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout")) .def("kill", &Actor::kill, py::call_guard(), "Kill that actor") - .def("kill_all", &Actor::kill_all, py::call_guard(), "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(), "Suspend that actor, that is blocked until resume()ed by another actor.") .def("resume", &Actor::resume, py::call_guard(), - "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(), "Kill all actors but the caller."); }