X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b7a2b0d929d417fef54cfd48c37107056f10eeaa..HEAD:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 7ba51a0b62..d00494965a 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -3,23 +3,16 @@ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#if defined(__GNUG__) -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wunused-value" -#endif - #include // Must come before our own stuff #include #include -#if defined(__GNUG__) -#pragma GCC diagnostic pop -#endif - #include "simgrid/kernel/ProfileBuilder.hpp" #include "simgrid/kernel/routing/NetPoint.hpp" +#include "simgrid/plugins/load.h" #include +#include #include #include #include @@ -27,11 +20,13 @@ #include #include #include +#include #include #include #include #include #include +#include #include #include @@ -40,20 +35,34 @@ #include namespace py = pybind11; +using simgrid::s4u::Activity; +using simgrid::s4u::ActivityPtr; +using simgrid::s4u::ActivitySet; +using simgrid::s4u::ActivitySetPtr; using simgrid::s4u::Actor; using simgrid::s4u::ActorPtr; using simgrid::s4u::Barrier; using simgrid::s4u::BarrierPtr; using simgrid::s4u::Comm; using simgrid::s4u::CommPtr; +using simgrid::s4u::CommTask; +using simgrid::s4u::CommTaskPtr; +using simgrid::s4u::Disk; using simgrid::s4u::Engine; +using simgrid::s4u::ExecTask; +using simgrid::s4u::ExecTaskPtr; using simgrid::s4u::Host; +using simgrid::s4u::Io; +using simgrid::s4u::IoTask; +using simgrid::s4u::IoTaskPtr; using simgrid::s4u::Link; using simgrid::s4u::Mailbox; using simgrid::s4u::Mutex; using simgrid::s4u::MutexPtr; using simgrid::s4u::Semaphore; using simgrid::s4u::SemaphorePtr; +using simgrid::s4u::Task; +using simgrid::s4u::TaskPtr; XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python"); @@ -67,15 +76,6 @@ std::string get_simgrid_version() sg_version_get(&major, &minor, &patch); return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch); } - -/** @brief Wrap for mailbox::get_async */ -class PyGetAsync { - std::unique_ptr data = std::make_unique(); - -public: - PyObject** get() const { return data.get(); } -}; - } // namespace PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr) @@ -139,19 +139,19 @@ PYBIND11_MODULE(simgrid, m) .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard(), "kill the current actor") .def( "on_exit", - [](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) { - py::gil_scoped_acquire py_context; // need a new context for callback + [](py::object fun) { + fun.inc_ref(); // keep alive after return + const py::gil_scoped_release gil_release; + simgrid::s4u::this_actor::on_exit([fun_p = fun.ptr()](bool failed) { + const py::gil_scoped_acquire py_context; // need a new context for callback try { + const auto fun = py::reinterpret_borrow(fun_p); fun(failed); } catch (const py::error_already_set& e) { xbt_die("Error while executing the on_exit lambda: %s", e.what()); } }); }, - 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") @@ -168,54 +168,16 @@ PYBIND11_MODULE(simgrid, m) return new simgrid::s4u::Engine(&argc, argv.data()); }), "The constructor should take the parameters from the command line, as is ") - .def_static("get_clock", - []() // XBT_ATTRIB_DEPRECATED_v334 - { - 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(); }, "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", - [](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); - return self.attr("all_hosts"); - }) .def("host_by_name", &Engine::host_by_name_or_null, "Retrieve a host by its name, or None if it does not exist in the platform.") .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform") - .def("get_all_links", - [](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); - 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", - [](py::object self) // XBT_ATTRIB_DEPRECATED_v334 - { - PyErr_WarnEx( - PyExc_DeprecationWarning, - "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", - [](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.", - 1); - return self.attr("netzone_root"); - }) .def_property_readonly("netzone_root", &Engine::get_netzone_root, "Retrieve the root netzone, containing all others.") .def("netpoint_by_name", &Engine::netpoint_by_name_or_null) @@ -233,15 +195,18 @@ PYBIND11_MODULE(simgrid, m) .def( "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; + fun_or_class.inc_ref(); // keep alive after return + const py::gil_scoped_release gil_release; + e->register_actor(name, [fun_or_class_p = fun_or_class.ptr()](std::vector args) { + const py::gil_scoped_acquire py_context; try { /* Convert the std::vector into a py::tuple */ py::tuple params(args.size() - 1); for (size_t i = 1; i < args.size(); i++) params[i - 1] = py::cast(args[i]); - py::object res = fun_or_class(*params); + const auto fun_or_class = py::reinterpret_borrow(fun_or_class_p); + py::object res = fun_or_class(*params); /* If I was passed a class, I just built an instance, so I need to call it now */ if (py::isinstance(res)) res(); @@ -254,7 +219,8 @@ PYBIND11_MODULE(simgrid, m) } }); }, - "Registers the main function of an actor"); + "Registers the main function of an actor") + .def("set_log_control", [](Engine*, const std::string& settings) { xbt_log_control_set(settings.c_str()); }); /* Class Netzone */ py::class_> netzone( @@ -270,10 +236,21 @@ PYBIND11_MODULE(simgrid, m) .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty") .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi") .def("add_route", - py::overload_cast&, bool>(&simgrid::s4u::NetZone::add_route), - "Add a route between 2 netpoints") + "Add a route between 2 hosts") + .def("add_route", + py::overload_cast&>(&simgrid::s4u::NetZone::add_route), + "Add a route between 2 hosts") + .def("add_route", + py::overload_cast&, bool>(&simgrid::s4u::NetZone::add_route), + "Add a route between 2 netzones. The gateway of each zone gets used.") + .def("add_route", + py::overload_cast&>(&simgrid::s4u::NetZone::add_route), + "Add a route between 2 netzones. The gateway of each zone gets used.") .def("create_host", py::overload_cast(&simgrid::s4u::NetZone::create_host), "Creates a host") .def("create_host", @@ -305,22 +282,22 @@ PYBIND11_MODULE(simgrid, m) .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", - [](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("set_gateway", py::overload_cast(&simgrid::s4u::NetZone::set_gateway), + "Specify the gateway of this zone, to be used for inter-zone routes") + .def("set_gateway", py::overload_cast(&simgrid::s4u::NetZone::set_gateway), + "Specify the gateway of this zone, to be used for inter-zone routes") .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", &simgrid::s4u::NetZone::get_name, - "The name of this network zone (read-only property)."); + "The name of this network zone (read-only property).") + .def( + "__repr__", [](const simgrid::s4u::NetZone net) { return "NetZone(" + net.get_name() + ")"; }, + "Textual representation of the NetZone"); /* Class ClusterCallbacks */ py::class_(m, "ClusterCallbacks", "Callbacks used to create cluster zones") - .def(py::init&, + .def(py::init&, const std::function&, const std::function&>()); @@ -383,41 +360,11 @@ PYBIND11_MODULE(simgrid, m) " \"\"\"\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", - [](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, "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_property_readonly("disks", &Host::get_disks, "The list of disks on this host (read-only).") .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host") - .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, py::cpp_function(&Host::set_core_count, py::call_guard()), "Manage the number of cores in the CPU") @@ -431,6 +378,8 @@ PYBIND11_MODULE(simgrid, m) py::overload_cast(&Host::create_disk), py::call_guard(), "Create a disk") .def("seal", &Host::seal, py::call_guard(), "Seal this host") + .def("turn_off", &Host::turn_off, py::call_guard(), "Turn off this host") + .def("turn_on", &Host::turn_on, py::call_guard(), "Turn on this host") .def_property("pstate", &Host::get_pstate, py::cpp_function(&Host::set_pstate, py::call_guard()), "The current pstate (read/write property).") @@ -451,22 +400,47 @@ PYBIND11_MODULE(simgrid, m) .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 + cb.inc_ref(); // keep alive after return + const py::gil_scoped_release gil_release; + Host::on_creation_cb([cb_p = cb.ptr()](Host& h) { + const py::gil_scoped_acquire py_context; // need a new context for callback try { + const auto fun = py::reinterpret_borrow(cb_p); fun(&h); } catch (const py::error_already_set& e) { xbt_die("Error while executing the on_creation lambda : %s", e.what()); } }); }, - py::call_guard(), ""); + "") + .def( + "__repr__", [](const Host* h) { return "Host(" + h->get_name() + ")"; }, + "Textual representation of the Host."); + + m.def("sg_host_load_plugin_init", [host]() { + sg_host_load_plugin_init(); + + static_cast>>(host) + .def( + "reset_load", [](const Host* h) { sg_host_load_reset(h); }, py::call_guard(), + "Reset counters of the host load plugin for this host.") + .def_property_readonly( + "current_load", [](const Host* h) { return sg_host_get_current_load(h); }, "Current load of the host.") + .def_property_readonly( + "avg_load", [](const Host* h) { return sg_host_get_avg_load(h); }, "Average load of the host.") + .def_property_readonly( + "idle_time", [](const Host* h) { return sg_host_get_idle_time(h); }, "Idle time of the host") + .def_property_readonly( + "total_idle_time", [](const Host* h) { return sg_host_get_total_idle_time(h); }, + "Total idle time of the host.") + .def_property_readonly( + "computed_flops", [](const Host* h) { return sg_host_get_computed_flops(h); }, + "Computed flops of the host."); + }); py::enum_(host, "SharingPolicy") .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR) - .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR) - .export_values(); + .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR); /* Class Disk */ py::class_> disk( @@ -483,16 +457,17 @@ PYBIND11_MODULE(simgrid, m) "Set sharing policy for this disk", py::arg("op"), py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb()) .def("seal", &simgrid::s4u::Disk::seal, py::call_guard(), "Seal this disk") - .def_property_readonly("name", &simgrid::s4u::Disk::get_name, "The name of this disk (read-only property)."); + .def_property_readonly("name", &simgrid::s4u::Disk::get_name, "The name of this disk (read-only property).") + .def( + "__repr__", [](const Disk* d) { return "Disk(" + d->get_name() + ")"; }, + "Textual representation of the Disk"); py::enum_(disk, "SharingPolicy") .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR) - .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR) - .export_values(); + .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR); py::enum_(disk, "Operation") .value("READ", simgrid::s4u::Disk::Operation::READ) .value("WRITE", simgrid::s4u::Disk::Operation::WRITE) - .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE) - .export_values(); + .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE); /* Class NetPoint */ py::class_> @@ -579,15 +554,22 @@ PYBIND11_MODULE(simgrid, m) .def_property_readonly("name", &Link::get_name, "The name of this link") .def_property_readonly("bandwidth", &Link::get_bandwidth, "The bandwidth (in bytes per second) (read-only property).") - .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property)."); - + .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property).") + .def( + "__repr__", [](const Link* l) { return "Link(" + l->get_name() + ")"; }, + "Textual representation of the Link"); py::enum_(link, "SharingPolicy") - .value("NONLINEAR", Link::SharingPolicy::NONLINEAR) - .value("WIFI", Link::SharingPolicy::WIFI) - .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX) - .value("SHARED", Link::SharingPolicy::SHARED) - .value("FATPIPE", Link::SharingPolicy::FATPIPE) - .export_values(); + .value("NONLINEAR", Link::SharingPolicy::NONLINEAR, + "This policy takes a callback that specifies the maximal capacity as a function of the number of usage. " + "See the examples with 'degradation' in their name.") + .value("WIFI", Link::SharingPolicy::WIFI, "Pseudo-sharing policy requesting wifi-specific sharing.") + .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX, + "Each link is split in 2, UP and DOWN, one per direction. These links are SHARED.") + .value("SHARED", Link::SharingPolicy::SHARED, + "The bandwidth is shared between all comms using that link, regardless of their direction.") + .value("FATPIPE", Link::SharingPolicy::FATPIPE, + "Each comm can use the link fully, with no sharing (only a maximum). This is intended to represent the " + "backbone links that cannot be saturated by concurrent links, but have a maximal bandwidth."); /* Class LinkInRoute */ py::class_ linkinroute(m, "LinkInRoute", "Abstraction to add link in routes"); @@ -596,35 +578,20 @@ PYBIND11_MODULE(simgrid, m) py::enum_(linkinroute, "Direction") .value("UP", simgrid::s4u::LinkInRoute::Direction::UP) .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN) - .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE) - .export_values(); + .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE); /* Class Split-Duplex Link */ py::class_>( m, "SplitDuplexLink", "Network split-duplex link") - .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_>( m, "Mailbox", "Mailbox. See the C++ documentation for details.") .def( - "__str__", [](const Mailbox* self) { return "Mailbox(" + self->get_name() + ")"; }, - "Textual representation of the Mailbox`") + "__repr__", [](const Mailbox* self) { return "Mailbox(" + self->get_name() + ")"; }, + "Textual representation of the Mailbox") .def_static("by_name", &Mailbox::by_name, py::call_guard(), py::arg("name"), "Retrieve a Mailbox from its name") .def_property_readonly("name", &Mailbox::get_name, "The name of that mailbox (read-only property).") @@ -633,85 +600,68 @@ PYBIND11_MODULE(simgrid, m) .def( "put", [](Mailbox* self, py::object data, uint64_t size, double timeout) { - data.inc_ref(); - self->put(data.ptr(), size, timeout); + auto* data_ptr = data.inc_ref().ptr(); + const py::gil_scoped_release gil_release; + self->put(data_ptr, size, timeout); }, - py::call_guard(), "Blocking data transmission with a timeout") + "Blocking data transmission with a timeout") .def( "put", [](Mailbox* self, py::object data, uint64_t size) { - data.inc_ref(); - self->put(data.ptr(), size); + auto* data_ptr = data.inc_ref().ptr(); + const py::gil_scoped_release gil_release; + self->put(data_ptr, size); }, - py::call_guard(), "Blocking data transmission") + "Blocking data transmission") .def( "put_async", [](Mailbox* self, py::object data, uint64_t size) { - data.inc_ref(); - return self->put_async(data.ptr(), size); + auto* data_ptr = data.inc_ref().ptr(); + const py::gil_scoped_release gil_release; + return self->put_async(data_ptr, size); }, - py::call_guard(), "Non-blocking data transmission") + "Non-blocking data transmission") .def( "put_init", [](Mailbox* self, py::object data, uint64_t size) { - data.inc_ref(); - return self->put_init(data.ptr(), size); + auto* data_ptr = data.inc_ref().ptr(); + const py::gil_scoped_release gil_release; + return self->put_init(data_ptr, size); }, - py::call_guard(), "Creates (but don’t start) a data transmission to that mailbox.") + "Creates (but don’t start) a data transmission to that mailbox.") .def( - "get", - [](Mailbox* self) { - py::object data = py::reinterpret_steal(self->get()); - // data.dec_ref(); // FIXME: why does it break python-actor-create? - return data; - }, + "get", [](Mailbox* self) { return py::reinterpret_steal(self->get()); }, py::call_guard(), "Blocking data reception") .def( - "get_async", - [](Mailbox* self) -> std::tuple { - PyGetAsync wrap; - auto comm = self->get_async(wrap.get()); - return std::make_tuple(std::move(comm), std::move(wrap)); - }, + "get_async", [](Mailbox* self) -> CommPtr { return self->get_async(); }, py::call_guard(), "Non-blocking data reception. Use data.get() to get the python object after the communication has finished") .def("set_receiver", &Mailbox::set_receiver, py::call_guard(), "Sets the actor as permanent receiver"); - /* Class PyGetAsync */ - py::class_(m, "PyGetAsync", "Wrapper for async get communications") - .def(py::init<>()) - .def( - "get", [](const PyGetAsync* self) { return py::reinterpret_steal(*(self->get())); }, - "Get python object after async communication in receiver side"); + /* class Activity */ + py::class_(m, "Activity", "Activity. See the C++ documentation for details."); /* Class Comm */ - py::class_(m, "Comm", "Communication. See the C++ documentation for details.") - .def_property_readonly("dst_data_size", &Comm::get_dst_data_size, - py::call_guard(), + py::class_(m, "Comm", "Communication. See the C++ documentation for details.") + .def_property_readonly("dst_data_size", &Comm::get_dst_data_size, py::call_guard(), "Retrieve the size of the received data.") - .def_property_readonly("mailbox", &Comm::get_mailbox, - py::call_guard(), + .def_property_readonly("mailbox", &Comm::get_mailbox, py::call_guard(), "Retrieve the mailbox on which this comm acts.") - .def_property_readonly("sender", &Comm::get_sender, - py::call_guard()) - .def_property_readonly("state_str", &Comm::get_state_str, - py::call_guard(), + .def_property_readonly("sender", &Comm::get_sender, py::call_guard()) + .def_property_readonly("state_str", &Comm::get_state_str, py::call_guard(), "Retrieve the Comm state as string") - .def_property_readonly("remaining", &Comm::get_remaining, - py::call_guard(), + .def_property_readonly("remaining", &Comm::get_remaining, py::call_guard(), "Remaining amount of work that this Comm entails") - .def_property_readonly("start_time", &Comm::get_start_time, - py::call_guard(), + .def_property_readonly("start_time", &Comm::get_start_time, py::call_guard(), "Time at which this Comm started") - .def_property_readonly("finish_time", &Comm::get_finish_time, - py::call_guard(), + .def_property_readonly("finish_time", &Comm::get_finish_time, py::call_guard(), "Time at which this Comm finished") - .def("set_payload_size", &Comm::set_payload_size, py::call_guard(), - py::arg("bytes"), + .def_property_readonly("is_suspended", &Comm::is_suspended, py::call_guard(), + "Whether this Comm is suspended") + .def("set_payload_size", &Comm::set_payload_size, py::call_guard(), py::arg("bytes"), "Specify the amount of bytes which exchange should be simulated.") - .def("set_rate", &Comm::set_rate, py::call_guard(), - py::arg("rate"), + .def("set_rate", &Comm::set_rate, py::call_guard(), py::arg("rate"), "Sets the maximal communication rate (in byte/sec). Must be done before start") .def("cancel", &Comm::cancel, py::call_guard(), py::return_value_policy::reference_internal, "Cancel the activity.") @@ -726,63 +676,40 @@ PYBIND11_MODULE(simgrid, m) "Test whether the communication is terminated.") .def("wait", &Comm::wait, py::call_guard(), "Block until the completion of that communication.") - .def("wait_for", &Comm::wait_for, py::call_guard(), - py::arg("timeout"), + .def("wait_for", &Comm::wait_for, py::call_guard(), py::arg("timeout"), "Block until the completion of that communication, or raises TimeoutException after the specified timeout.") - .def("wait_until", &Comm::wait_until, py::call_guard(), - py::arg("time_limit"), + .def("wait_until", &Comm::wait_until, py::call_guard(), py::arg("time_limit"), "Block until the completion of that communication, or raises TimeoutException after the specified time.") + .def( + "get_payload", + [](const Comm* self) { return py::reinterpret_steal((PyObject*)self->get_payload()); }, + py::call_guard(), + "Retrieve the message's payload of a get_async. You cannot call this until after the comm termination.") .def("detach", py::overload_cast<>(&Comm::detach), py::return_value_policy::reference_internal, py::call_guard(), "Start the comm, and ignore its result. It can be completely forgotten after that.") - .def_static("sendto", &Comm::sendto, py::call_guard(), - py::arg("from"), py::arg("to"), py::arg("simulated_size_in_bytes"), - "Do a blocking communication between two arbitrary hosts.") + .def_static("sendto", &Comm::sendto, py::call_guard(), py::arg("from"), py::arg("to"), + py::arg("simulated_size_in_bytes"), "Do a blocking communication between two arbitrary hosts.") .def_static("sendto_init", py::overload_cast(&Comm::sendto_init), - py::call_guard(), - py::arg("from"), py::arg("to"), + py::call_guard(), py::arg("from"), py::arg("to"), "Creates a communication between the two given hosts, bypassing the mailbox mechanism.") - .def_static("sendto_async", &Comm::sendto_async, py::call_guard(), - py::arg("from"), py::arg("to"), py::arg("simulated_size_in_bytes"), + .def_static("sendto_async", &Comm::sendto_async, py::call_guard(), py::arg("from"), + py::arg("to"), py::arg("simulated_size_in_bytes"), "Do a blocking communication between two arbitrary hosts.\n\nThis initializes a communication that " "completely bypass the mailbox and actors mechanism. There is really no limit on the hosts involved. " - "In particular, the actor does not have to be on one of the involved hosts.") - .def_static("test_any", &Comm::test_any, - py::call_guard(), - py::arg("comms"), - "take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done)") - .def_static("wait_all", &Comm::wait_all, py::call_guard(), - py::arg("comms"), - "Block until the completion of all communications in the list.") - .def_static("wait_all_for", &Comm::wait_all_for, py::call_guard(), - py::arg("comms"), py::arg("timeout"), - "Block until the completion of all communications in the list, or raises TimeoutException after " - "the specified timeout.") - .def_static("wait_any", &Comm::wait_any, - py::call_guard(), - py::arg("comms"), - "Block until the completion of any communication in the list and return the index of the " - "terminated one.") - .def_static("wait_any_for", &Comm::wait_any_for, - py::call_guard(), - py::arg("comms"), py::arg("timeout"), - "Block until the completion of any communication in the list and return the index of the terminated " - "one, or -1 if a timeout occurred."); + "In particular, the actor does not have to be on one of the involved hosts."); /* Class Io */ - py::class_(m, "Io", "I/O activities. See the C++ documentation for details.") + py::class_(m, "Io", + "I/O activities. See the C++ documentation for details.") .def("test", &simgrid::s4u::Io::test, py::call_guard(), "Test whether the I/O is terminated.") .def("wait", &simgrid::s4u::Io::wait, py::call_guard(), - "Block until the completion of that I/O operation") - .def_static( - "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard(), - "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.") - .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard(), - "Block until the completion of any I/O in the list and return the index of the terminated one."); + "Block until the completion of that I/O operation"); /* Class Exec */ - py::class_(m, "Exec", "Execution. See the C++ documentation for details.") + py::class_(m, "Exec", + "Execution. See the C++ documentation for details.") .def_property_readonly("remaining", &simgrid::s4u::Exec::get_remaining, py::call_guard(), "Amount of flops that remain to be computed until completion (read-only property).") .def_property_readonly("remaining_ratio", &simgrid::s4u::Exec::get_remaining_ratio, @@ -792,15 +719,17 @@ PYBIND11_MODULE(simgrid, m) .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host, "Host on which this execution runs. Only the first host is returned for parallel executions. " "Changing this value migrates the execution.") + .def_property_readonly("is_suspended", &simgrid::s4u::Exec::is_suspended, + py::call_guard(), "Whether this Exec is suspended") .def("test", &simgrid::s4u::Exec::test, py::call_guard(), "Test whether the execution is terminated.") .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard(), "Cancel that execution.") .def("start", &simgrid::s4u::Exec::start, py::call_guard(), "Start that execution.") .def("suspend", &simgrid::s4u::Exec::suspend, py::call_guard(), "Suspend that execution.") + .def("resume", &simgrid::s4u::Exec::resume, py::call_guard(), "Resume that execution.") .def("wait", &simgrid::s4u::Exec::wait, py::call_guard(), "Block until the completion of that execution.") - .def("wait_for", &simgrid::s4u::Exec::wait_for, py::call_guard(), - py::arg("timeout"), + .def("wait_for", &simgrid::s4u::Exec::wait_for, py::call_guard(), py::arg("timeout"), "Block until the completion of that activity, or raises TimeoutException after the specified timeout."); /* Class Semaphore */ @@ -814,8 +743,7 @@ PYBIND11_MODULE(simgrid, m) .def("acquire_timeout", &Semaphore::acquire_timeout, py::call_guard(), py::arg("timeout"), "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired or return " "true if it has not been acquired after the specified timeout.") - .def("release", &Semaphore::release, py::call_guard(), - "Release the semaphore.") + .def("release", &Semaphore::release, py::call_guard(), "Release the semaphore.") .def_property_readonly("capacity", &Semaphore::get_capacity, py::call_guard(), "Get the semaphore capacity.") .def_property_readonly("would_block", &Semaphore::would_block, py::call_guard(), @@ -830,19 +758,20 @@ PYBIND11_MODULE(simgrid, m) py::class_(m, "Mutex", "A classical mutex, but blocking in the simulation world." "See the C++ documentation for details.") - .def(py::init<>(&Mutex::create), py::call_guard(), "Mutex constructor.") + .def(py::init<>(&Mutex::create), py::call_guard(), + "Mutex constructor (pass True as a parameter to get a recursive Mutex).", py::arg("recursive") = false) .def("lock", &Mutex::lock, py::call_guard(), "Block until the mutex is acquired.") .def("try_lock", &Mutex::try_lock, py::call_guard(), "Try to acquire the mutex. Return true if the mutex was acquired, false otherwise.") .def("unlock", &Mutex::unlock, py::call_guard(), "Release the mutex.") // Allow mutexes to be automatically acquired/released with a context manager: `with mutex: ...` .def("__enter__", &Mutex::lock, py::call_guard()) - .def("__exit__", [](Mutex* self, const py::object&, const py::object&, const py::object&) { self->unlock(); }, - py::call_guard()); + .def( + "__exit__", [](Mutex* self, const py::object&, const py::object&, const py::object&) { self->unlock(); }, + py::call_guard()); /* Class Barrier */ - py::class_(m, "Barrier", - "A classical barrier, but blocking in the simulation world.") + py::class_(m, "Barrier", "A classical barrier, but blocking in the simulation world.") .def(py::init<>(&Barrier::create), py::call_guard(), py::arg("expected_actors"), "Barrier constructor.") .def("wait", &Barrier::wait, py::call_guard(), @@ -856,11 +785,14 @@ PYBIND11_MODULE(simgrid, m) .def( "create", [](const std::string& name, Host* h, py::object fun, py::args args) { - 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; + fun.inc_ref(); // keep alive after return + args.inc_ref(); // keep alive after return + const py::gil_scoped_release gil_release; + return simgrid::s4u::Actor::create(name, h, [fun_p = fun.ptr(), args_p = args.ptr()]() { + const py::gil_scoped_acquire py_context; try { + const auto fun = py::reinterpret_borrow(fun_p); + const auto args = py::reinterpret_borrow(args_p); fun(*args); } catch (const py::error_already_set& ex) { if (ex.matches(pyForcefulKillEx)) { @@ -871,7 +803,6 @@ PYBIND11_MODULE(simgrid, m) } }); }, - py::call_guard(), "Create an actor from a function or an object. See the :ref:`example `.") .def_property( "host", &Actor::get_host, py::cpp_function(&Actor::set_host, py::call_guard()), @@ -904,5 +835,141 @@ PYBIND11_MODULE(simgrid, m) .def("resume", &Actor::resume, py::call_guard(), "Resume that actor, that was previously suspend()ed.") .def_static("kill_all", &Actor::kill_all, py::call_guard(), - "Kill all actors but the caller."); + "Kill all actors but the caller.") + .def( + "__repr__", [](const ActorPtr a) { return "Actor(" + a->get_name() + ")"; }, + "Textual representation of the Actor"); + + /* Enum Class IoOpType */ + py::enum_(m, "IoOpType") + .value("READ", simgrid::s4u::Io::OpType::READ) + .value("WRITE", simgrid::s4u::Io::OpType::WRITE); + + /* Class Task */ + py::class_(m, "Task", "Task. See the C++ documentation for details.") + .def_static( + "on_start_cb", + [](py::object cb) { + cb.inc_ref(); // keep alive after return + const py::gil_scoped_release gil_release; + Task::on_start_cb([cb_p = cb.ptr()](Task* op) { + const py::gil_scoped_acquire py_context; // need a new context for callback + py::reinterpret_borrow(cb_p)(op); + }); + }, + "Add a callback called when each task starts.") + .def_static( + "on_completion_cb", + [](py::object cb) { + cb.inc_ref(); // keep alive after return + const py::gil_scoped_release gil_release; + Task::on_completion_cb([cb_p = cb.ptr()](Task* op) { + const py::gil_scoped_acquire py_context; // need a new context for callback + py::reinterpret_borrow(cb_p)(op); + }); + }, + "Add a callback called when each task ends.") + .def_property_readonly("name", &Task::get_name, "The name of this task (read-only).") + .def_property_readonly("successors", &Task::get_successors, "The successors of this task (read-only).") + .def_property("amount", &Task::get_amount, &Task::set_amount, "The amount of work to do for this task.") + .def( + "get_count", [](const TaskPtr t) { return t->get_count("instance_0"); }, + "The execution count of this task instance_0.") + .def( + "get_count", [](const TaskPtr t, const std::string& instance) { return t->get_count(instance); }, + "The execution count of this task instance.") + .def("enqueue_firings", py::overload_cast(&Task::enqueue_firings), py::call_guard(), + py::arg("n"), "Enqueue firings for this task.") + .def("add_successor", py::overload_cast(&Task::add_successor), py::call_guard(), + py::arg("op"), "Add a successor to this task.") + .def("remove_successor", py::overload_cast(&Task::remove_successor), + py::call_guard(), py::arg("op"), "Remove a successor of this task.") + .def("remove_all_successors", &Task::remove_all_successors, py::call_guard(), + "Remove all successors of this task.") + .def("on_this_start_cb", py::overload_cast&>(&Task::on_this_start_cb), + py::arg("func"), "Add a callback called when this task starts.") + .def("on_this_completion_cb", py::overload_cast&>(&Task::on_this_completion_cb), + py::arg("func"), "Add a callback called when this task ends.") + .def( + "__repr__", [](const TaskPtr op) { return "Task(" + op->get_name() + ")"; }, + "Textual representation of the Task"); + + /* Class CommTask */ + py::class_(m, "CommTask", "Communication Task. See the C++ documentation for details.") + .def_static("init", py::overload_cast(&CommTask::init), + py::call_guard(), py::arg("name"), "CommTask constructor") + .def_static("init", py::overload_cast(&CommTask::init), + py::call_guard(), py::arg("name"), py::arg("bytes"), py::arg("source"), + py::arg("destination"), "CommTask constructor") + .def_property("source", &CommTask::get_source, &CommTask::set_source, "The source of the communication.") + .def_property("destination", &CommTask::get_destination, &CommTask::set_destination, + "The destination of the communication.") + .def_property("bytes", &CommTask::get_bytes, &CommTask::set_bytes, "The amount of bytes to send.") + .def( + "__repr__", [](const CommTaskPtr c) { return "CommTask(" + c->get_name() + ")"; }, + "Textual representation of the CommTask"); + + /* Class ExecTask */ + py::class_(m, "ExecTask", "Execution Task. See the C++ documentation for details.") + .def_static("init", py::overload_cast(&ExecTask::init), + py::call_guard(), py::arg("name"), "ExecTask constructor") + .def_static("init", py::overload_cast(&ExecTask::init), + py::call_guard(), py::arg("name"), py::arg("flops"), py::arg("host"), + "CommTask constructor.") + .def_property("host", &ExecTask::get_host, &ExecTask::set_host, "The host of the execution.") + .def_property("flops", &ExecTask::get_flops, &ExecTask::set_flops, "The amount of flops to execute.") + .def( + "__repr__", [](const ExecTaskPtr e) { return "ExecTask(" + e->get_name() + ")"; }, + "Textual representation of the ExecTask"); + + /* Class IoTask */ + py::class_(m, "IoTask", "IO Task. See the C++ documentation for details.") + .def_static("init", py::overload_cast(&IoTask::init), + py::call_guard(), py::arg("name"), "IoTask constructor") + .def_static("init", py::overload_cast(&IoTask::init), + py::call_guard(), py::arg("name"), py::arg("bytes"), py::arg("disk"), + py::arg("type"), "IoTask constructor.") + .def_property("disk", &IoTask::get_disk, &IoTask::set_disk, "The disk of the IO.") + .def_property("bytes", &IoTask::get_bytes, &IoTask::set_bytes, "The amount of bytes to process.") + .def_property("type", &IoTask::get_bytes, &IoTask::set_bytes, "The type of IO.") + .def( + "__repr__", [](const IoTaskPtr io) { return "IoTask(" + io->get_name() + ")"; }, + "Textual representation of the IoTask"); + + /* Class ActivitySet */ + py::class_(m, "ActivitySet", "ActivitySet. See the C++ documentation for details.") + .def(py::init([](std::vector activities) { + auto* ret = new ActivitySet(); + for (auto a : activities) + ret->push(a); + return ActivitySetPtr(ret); + }), + "The constructor should take the parameters from the command line, as is ") + .def(py::init([]() { return ActivitySetPtr(new ActivitySet()); }), + "The constructor should take the parameters from the command line, as is ") + + .def("push", &ActivitySet::push, py::call_guard(), py::arg("activity"), + "Add an activity to the set") + .def("erase", &ActivitySet::erase, py::call_guard(), py::arg("activity"), + "Remove that activity from the set") + .def_property_readonly("size", &ActivitySet::size, "Count of activities in the set") + .def("empty", &ActivitySet::empty, "Returns whether the set is empty") + .def("has_failed_activities", &ActivitySet::has_failed_activities, + "Returns whether there is any failed activities") + .def("get_failed_activity", &ActivitySet::get_failed_activity, "Returns a failed activity from the set, or None") + + .def("wait_all_for", &ActivitySet::wait_all_for, py::call_guard(), py::arg("timeout"), + "Wait for the completion of all activities in the set, but not longer than the provided timeout") + .def("wait_all", &ActivitySet::wait_all, py::call_guard(), + "Wait for the completion of all activities in the set, endlessly") + .def("test_any", &ActivitySet::test_any, py::call_guard(), + "Returns the first terminated activity if any, or None if no activity is terminated") + .def("wait_any_for", &ActivitySet::wait_any_for, py::call_guard(), py::arg("timeout"), + "Wait for the completion of one activity in the set, but not longer than the provided timeout") + .def("wait_any", &ActivitySet::wait_any, py::call_guard(), + "Wait for the completion of one activity in the set, endlessly") + + .def( + "__repr__", [](const ActivitySetPtr as) { return "ActivitySet([...])"; }, + "Textual representation of the ActivitySet"); }