X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9902ebbb51218fa8509e97dbbe4bf118eba3207b..60a81418ae15d47b18247171b721e207b71d6279:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 73ade243c0..3d3a86c1e8 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2018-2021. The SimGrid Team. All rights reserved. */ /* 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. */ @@ -13,24 +13,47 @@ #pragma GCC diagnostic ignored "-Wunused-value" #endif -#include +#ifndef NDEBUG +/* Many tests are failing after pybind11 commit ad6bf5cd39ca64b4a9bf846b84b11c4c8df1c8e1 "Adding PyGILState_Check() in + * object_api<>::operator(). (#2919)". + * See https://github.com/pybind/pybind11/commit/ad6bf5cd39ca64b4a9bf846b84b11c4c8df1c8e1 + * + * The failing tests are mostly those with boost/raw/sysv contexts. As a workaround, define NDEBUG before pybind11 + * includes. + */ +#define NDEBUG +#define NDEBUG_LOCALLY_DEFINED +#endif + #include // Must come before our own stuff + +#include #include +#ifdef NDEBUG_LOCALLY_DEFINED +#undef NDEBUG_LOCALLY_DEFINED +#undef NDEBUG +#endif + #if defined(__GNUG__) #pragma GCC diagnostic pop #endif +#include "simgrid/kernel/routing/NetPoint.hpp" #include "src/kernel/context/Context.hpp" #include #include #include +#include #include #include #include +#include #include +#include #include +#include #include #include #include @@ -46,7 +69,7 @@ XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python"); namespace { -static std::string get_simgrid_version() +std::string get_simgrid_version() { int major; int minor; @@ -55,6 +78,52 @@ static std::string get_simgrid_version() 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(); } +}; + +/* Classes GilScopedAcquire and GilScopedRelease have the same purpose as pybind11::gil_scoped_acquire and + * pybind11::gil_scoped_release. Refer to the manual of pybind11 for details: + * https://pybind11.readthedocs.io/en/stable/advanced/misc.html#global-interpreter-lock-gil + * + * The pybind11 versions are however too sophisticated (using TLS for example) and don't work well with all kinds of + * contexts. + * See also https://github.com/pybind/pybind11/issues/1276, which may be related. + * + * Briefly, GilScopedAcquire can be used on actor creation to acquire a new PyThreadState. The PyThreadState has to be + * released for context switches (i.e. before simcalls). That's the purpose of GilScopedRelease. + * + * Like their pybind11 counterparts, both classes use a RAII pattern. + */ +class XBT_PRIVATE GilScopedAcquire { + static PyThreadState* acquire() + { + PyThreadState* state = PyThreadState_New(PyInterpreterState_Head()); + PyEval_AcquireThread(state); + return state; + } + static void release(PyThreadState* state) + { + PyEval_ReleaseThread(state); + PyThreadState_Clear(state); + PyThreadState_Delete(state); + } + + std::unique_ptr thread_state{acquire(), &release}; + +public: + void reset() { thread_state.reset(); } +}; + +class XBT_PRIVATE GilScopedRelease { + std::unique_ptr thread_state{PyEval_SaveThread(), + &PyEval_RestoreThread}; +}; + } // namespace PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr) @@ -69,231 +138,425 @@ PYBIND11_MODULE(simgrid, m) static py::object pyForcefulKillEx(py::register_exception(m, "ActorKilled")); /* this_actor namespace */ - py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace."); - m2.def("info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority."); - m2.def("error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority."); - m2.def("execute", py::overload_cast(&simgrid::s4u::this_actor::execute), - "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void " - "simgrid::s4u::this_actor::execute(double, double)`", - py::arg("flops"), py::arg("priority") = 1); - m2.def("exec_init", [](double flops) { return simgrid::s4u::this_actor::exec_init(flops); }); - m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located"); - m2.def("set_host", &simgrid::s4u::this_actor::set_host, - "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::set_host()`", - py::arg("dest")); - m2.def( - "sleep_for", static_cast(&simgrid::s4u::this_actor::sleep_for), - "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`", - py::arg("duration")); - m2.def("sleep_until", static_cast(&simgrid::s4u::this_actor::sleep_until), - "Block the actor sleeping until the specified timestamp, see :cpp:func:`void " - "simgrid::s4u::this_actor::sleep_until`", - py::arg("duration")); - m2.def("suspend", &simgrid::s4u::this_actor::suspend, "Suspend the current actor, that is blocked until resume()ed " - "by another actor. see :cpp:func:`void " - "simgrid::s4u::this_actor::suspend`"); - m2.def("yield_", &simgrid::s4u::this_actor::yield, - "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`"); - m2.def("exit", &simgrid::s4u::this_actor::exit, "kill the current actor"); - m2.def("on_exit", - [](py::object fun) { - ActorPtr act = Actor::self(); - simgrid::s4u::this_actor::on_exit([act, fun](bool /*failed*/) { - try { - fun(); - } catch (const py::error_already_set& e) { - xbt_die("Error while executing the on_exit lambda: %s", e.what()); - } - }); - }, - ""); + m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.") + .def( + "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' 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), + py::call_guard(), + "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"), + py::arg("priority") = 1) + .def("exec_init", py::overload_cast(&simgrid::s4u::this_actor::exec_init), + py::call_guard()) + .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located") + .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard(), + "Moves the current actor to another host.", py::arg("dest")) + .def("sleep_for", static_cast(&simgrid::s4u::this_actor::sleep_for), + py::call_guard(), "Block the actor sleeping for that amount of seconds.", + py::arg("duration")) + .def("sleep_until", static_cast(&simgrid::s4u::this_actor::sleep_until), + py::call_guard(), "Block the actor sleeping until the specified timestamp.", + py::arg("duration")) + .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard(), + "Suspend the current actor, that is blocked until resume()ed by another actor.") + .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard(), "Yield the actor") + .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard(), "kill the current actor") + .def( + "on_exit", + [](py::object fun) { + 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*/) { + GilScopedAcquire py_context; // need a new context for callback + try { + fun(); + } catch (const py::error_already_set& e) { + std::string what = e.what(); + py_context.reset(); + xbt_die("Error while executing the on_exit lambda: %s", what.c_str()); + } + }); + }, + py::call_guard(), ""); /* Class Engine */ - py::class_(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine `") + py::class_(m, "Engine", "Simulation Engine") .def(py::init([](std::vector args) { - static char noarg[] = {'\0'}; - int argc = args.size(); - std::unique_ptr argv(new char*[argc + 1]); - for (int i = 0; i != argc; ++i) - argv[i] = args[i].empty() ? noarg : &args[i].front(); - argv[argc] = nullptr; + auto argc = static_cast(args.size()); + std::vector argv(args.size() + 1); // argv[argc] is nullptr + std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); }); // Currently this can be dangling, we should wrap this somehow. - return new simgrid::s4u::Engine(&argc, argv.get()); + return new simgrid::s4u::Engine(&argc, argv.data()); })) .def_static("get_clock", &Engine::get_clock, "The simulation time, ie the amount of simulated seconds since the simulation start.") .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform") - .def("load_platform", &Engine::load_platform, - "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`") - .def("load_deployment", &Engine::load_deployment, - "Load a deployment file and launch the actors that it contains, see " - ":cpp:func:`simgrid::s4u::Engine::load_deployment()`") - .def("run", &Engine::run, "Run the simulation") - .def("register_actor", - [](Engine* e, const std::string& name, py::object fun_or_class) { - e->register_actor(name, [fun_or_class](std::vector args) { - 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); - - /* If I was passed a class, I just built an instance, so I need to call it now */ - if (py::isinstance(res)) - res(); - } catch (const py::error_already_set& ex) { - if (ex.matches(pyForcefulKillEx)) { - XBT_VERB("Actor killed"); - /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */ - } else { - throw; - } - } - }); - }, - "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_actor()`"); + .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment") + .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains") + .def("run", &Engine::run, py::call_guard(), "Run the simulation") + .def( + "register_actor", + [](Engine* e, const std::string& name, py::object fun_or_class) { + e->register_actor(name, [fun_or_class](std::vector args) { + GilScopedAcquire 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); + /* If I was passed a class, I just built an instance, so I need to call it now */ + if (py::isinstance(res)) + res(); + } catch (const py::error_already_set& ex) { + bool ffk = ex.matches(pyForcefulKillEx); + py_context.reset(); + if (ffk) { + XBT_VERB("Actor killed"); + simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception + } + throw; + } + }); + }, + "Registers the main function of an actor"); + + /* Class Netzone */ + py::class_> netzone(m, "NetZone", + "Networking Zones"); + netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone") + .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus") + .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree") + .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly") + .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star") + .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd") + .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra") + .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi") + .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") + .def("create_host", py::overload_cast(&simgrid::s4u::NetZone::create_host), + "Creates a host") + .def("create_host", + py::overload_cast(&simgrid::s4u::NetZone::create_host), + "Creates a host") + .def("create_host", + py::overload_cast&>(&simgrid::s4u::NetZone::create_host), + "Creates a host") + .def("create_host", + py::overload_cast&>(&simgrid::s4u::NetZone::create_host), + "Creates a host") + .def("create_link", py::overload_cast(&simgrid::s4u::NetZone::create_link), + "Creates a network link") + .def("create_link", + py::overload_cast(&simgrid::s4u::NetZone::create_link), + "Creates a network link") + .def("create_link", + py::overload_cast&>(&simgrid::s4u::NetZone::create_link), + "Creates a network link") + .def("create_link", + py::overload_cast&>(&simgrid::s4u::NetZone::create_link), + "Creates a network link") + .def("create_split_duplex_link", + py::overload_cast(&simgrid::s4u::NetZone::create_split_duplex_link), + "Creates a split-duplex link") + .def("create_split_duplex_link", + py::overload_cast(&simgrid::s4u::NetZone::create_split_duplex_link), + "Creates a split-duplex link") + .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("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone") + .def_property_readonly( + "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); }, "The name of this network zone"); + + /* Class ClusterCallbacks */ + py::class_(m, "ClusterCallbacks", "Callbacks used to create cluster zones") + .def(py::init&, + const std::function&, + const std::function&>()); + + /* Class FatTreeParams */ + py::class_(m, "FatTreeParams", "Parameters to create a Fat-Tree zone") + .def(py::init&, const std::vector&, + const std::vector&>()); + + /* Class DragonflyParams */ + py::class_(m, "DragonflyParams", "Parameters to create a Dragonfly zone") + .def(py::init&, const std::pair&, + const std::pair&, unsigned int>()); /* Class Host */ - py::class_>( - m, "Host", "Simulation Engine, see :ref:`class s4u::Host `") - .def("by_name", &Host::by_name, "Retrieves a host from its name, or die") - .def("get_pstate_count", &Host::get_pstate_count, - "Retrieve the cound of defined pstate levels, see :cpp:func:`simgrid::s4u::Host::get_pstate_count`") - .def("get_pstate_speed", &Host::get_pstate_speed, - "Retrieve the maximal speed at the given pstate, see :cpp:func:`simgrid::s4u::Host::get_pstate_speed`") - .def_property("pstate", &Host::get_pstate, &Host::set_pstate, "The current pstate") - - .def("current", &Host::current, - "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`") - .def_property_readonly("name", - [](const Host* self) { - return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC - }, - "The name of this host") + py::class_> host(m, "Host", "Simulated host"); + host.def("by_name", &Host::by_name, "Retrieves a host from its name, or die") + .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_disks", &Host::get_disks, "Retrieve the list of disks in this host") + .def("set_core_count", &Host::set_core_count, "Set the number of cores in the CPU") + .def("set_coordinates", &Host::set_coordinates, "Set the coordinates of this host") + .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, "Describe how the CPU is shared", + py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb()) + .def("create_disk", py::overload_cast(&Host::create_disk), "Create a disk") + .def("create_disk", + py::overload_cast(&Host::create_disk), + "Create a disk") + .def("seal", &Host::seal, "Seal this host") + .def_property( + "pstate", &Host::get_pstate, + [](Host* h, int i) { + GilScopedRelease gil_guard; + h->set_pstate(i); + }, + "The current pstate") + .def("current", &Host::current, py::call_guard(), + "Retrieves the host on which the running actor is located.") + .def_property_readonly( + "name", + [](const Host* self) { + return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC + }, + "The name of this host") .def_property_readonly( "load", &Host::get_load, - "Returns the current computation load (in flops per second). This is the currently achieved speed. " - "See :cpp:func:`simgrid::s4u::Host::get_load()`") + "Returns the current computation load (in flops per second). This is the currently achieved speed.") .def_property_readonly( "speed", &Host::get_speed, "The peak computing speed in flops/s at the current pstate, taking the external load into account. " - "This is the max potential speed. See :cpp:func:`simgrid::s4u::Host::get_speed()`"); + "This is the max potential speed."); + py::enum_(host, "SharingPolicy") + .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR) + .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR) + .export_values(); + + /* Class Disk */ + py::class_> disk(m, "Disk", "Simulated disk"); + disk.def("read", &simgrid::s4u::Disk::read, py::call_guard(), "Read data from disk") + .def("write", &simgrid::s4u::Disk::write, py::call_guard(), "Write data in disk") + .def("read_async", &simgrid::s4u::Disk::read_async, "Non-blocking read data from disk") + .def("write_async", &simgrid::s4u::Disk::write_async, "Non-blocking write data in disk") + .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, "Set sharing policy for this disk", + py::arg("op"), py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb()) + .def("seal", &simgrid::s4u::Disk::seal, "Seal this disk") + .def_property_readonly( + "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); }, "The name of this disk"); + py::enum_(disk, "SharingPolicy") + .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR) + .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR) + .export_values(); + 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(); + + /* Class NetPoint */ + py::class_> + netpoint(m, "NetPoint", "NetPoint object"); + + /* Class Link */ + py::class_> link(m, "Link", "Network link"); + link.def("set_latency", py::overload_cast(&simgrid::s4u::Link::set_latency), "Set the latency") + .def("set_latency", py::overload_cast(&simgrid::s4u::Link::set_latency), "Set the latency") + .def("set_sharing_policy", &simgrid::s4u::Link::set_sharing_policy, "Set sharing policy for this link") + .def("set_concurrency_limit", &simgrid::s4u::Link::set_concurrency_limit, "Set concurrency limit for this link") + .def("set_host_wifi_rate", &simgrid::s4u::Link::set_host_wifi_rate, + "Set level of communication speed of given host on this Wi-Fi link") + .def("seal", &simgrid::s4u::Link::seal, "Seal this link") + .def_property_readonly( + "name", + [](const simgrid::s4u::Link* self) { + return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC + }, + "The name of this link"); + py::enum_(link, "SharingPolicy") + .value("NONLINEAR", simgrid::s4u::Link::SharingPolicy::NONLINEAR) + .value("WIFI", simgrid::s4u::Link::SharingPolicy::WIFI) + .value("SPLITDUPLEX", simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) + .value("SHARED", simgrid::s4u::Link::SharingPolicy::SHARED) + .value("FATPIPE", simgrid::s4u::Link::SharingPolicy::FATPIPE) + .export_values(); + + /* Class LinkInRoute */ + py::class_ linkinroute(m, "LinkInRoute", "Abstraction to add link in routes"); + linkinroute.def(py::init()); + linkinroute.def(py::init()); + 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(); + + /* Class Split-Duplex Link */ + py::class_>(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"); /* Class Mailbox */ - py::class_>( - m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox `") - .def("__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; }, - "Textual representation of the Mailbox`") - .def("by_name", &Mailbox::by_name, - "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`") - .def_property_readonly("name", - [](const Mailbox* self) { - return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC - }, - "The name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`") - .def("put", - [](Mailbox* self, py::object data, int size) { - data.inc_ref(); - self->put(data.ptr(), size); - }, - "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`") - .def("put_async", - [](Mailbox* self, py::object data, int size) { - data.inc_ref(); - return self->put_async(data.ptr(), size); - }, - "Non-blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put_async(void*, uint64_t)`") - .def("get", - [](Mailbox* self) { - py::object data = pybind11::reinterpret_steal(static_cast(self->get())); - data.dec_ref(); - return data; - }, - "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`"); + py::class_>(m, "Mailbox", "Mailbox") + .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_property_readonly( + "name", + [](const Mailbox* self) { + return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC + }, + "The name of that mailbox") + .def( + "put", + [](Mailbox* self, py::object data, int size) { + data.inc_ref(); + self->put(data.ptr(), size); + }, + py::call_guard(), "Blocking data transmission") + .def( + "put_async", + [](Mailbox* self, py::object data, int size) { + data.inc_ref(); + return self->put_async(data.ptr(), size); + }, + py::call_guard(), "Non-blocking data transmission") + .def( + "get", + [](Mailbox* self) { + py::object data = pybind11::reinterpret_steal(self->get()); + // data.dec_ref(); // FIXME: why does it break python-actor-create? + return data; + }, + 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)); + }, + py::call_guard(), + "Non-blocking data reception. Use data.get() to get the python object after the communication has finished") + .def( + "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); }, + 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 Comm */ - py::class_(m, "Comm", - "Communication, see :ref:`class s4u::Comm `") - .def("test", [](simgrid::s4u::CommPtr self) { return self->test(); }, - "Test whether the communication is terminated, see :cpp:func:`simgrid::s4u::Comm::test()`") - .def("wait", [](simgrid::s4u::CommPtr self) { self->wait(); }, - "Block until the completion of that communication, see :cpp:func:`simgrid::s4u::Comm::wait()`") - .def("wait_all", [](const std::vector* comms) { simgrid::s4u::Comm::wait_all(comms); }, - "Block until the completion of all communications in the list, see " - ":cpp:func:`simgrid::s4u::Comm::wait_all()`") - .def("wait_any", - [](const std::vector* comms) { return simgrid::s4u::Comm::wait_any(comms); }, - "Block until the completion of any communication in the list and return the index of the terminated one, " - "see :cpp:func:`simgrid::s4u::Comm::wait_any()`"); + py::class_(m, "Comm", "Communication") + .def("test", &simgrid::s4u::Comm::test, py::call_guard(), + "Test whether the communication is terminated.") + .def("wait", &simgrid::s4u::Comm::wait, py::call_guard(), + "Block until the completion of that communication.") + // 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.") + .def_static( + "wait_any", py::overload_cast&>(&simgrid::s4u::Comm::wait_any), + py::call_guard(), + "Block until the completion of any communication in the list and return the index of the terminated one."); + + /* Class Io */ + py::class_(m, "Io", "I/O activities") + .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."); /* Class Exec */ - py::class_(m, "Exec", - "Execution, see :ref:`class s4u::Exec `") - .def_property_readonly("remaining", [](simgrid::s4u::ExecPtr self) { return self->get_remaining(); }, - "Amount of flops that remain to be computed until completion, see " - ":cpp:func:`simgrid::s4u::Exec::get_remaining()`") - .def_property_readonly("remaining_ratio", [](simgrid::s4u::ExecPtr self) { return self->get_remaining_ratio(); }, - "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done " - "yet). See :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`") - .def_property("host", - [](simgrid::s4u::ExecPtr self) { - simgrid::s4u::ExecSeqPtr seq = boost::dynamic_pointer_cast(self); - if (seq != nullptr) - return seq->get_host(); - xbt_throw_unimplemented(__FILE__, __LINE__, - "host of parallel executions is not implemented in python yet."); - }, - [](simgrid::s4u::ExecPtr self, simgrid::s4u::Host* host) { self->set_host(host); }, - "Host on which this execution runs. See :cpp:func:`simgrid::s4u::ExecSeq::get_host()`") - .def("test", [](simgrid::s4u::ExecPtr self) { return self->test(); }, - "Test whether the execution is terminated, see :cpp:func:`simgrid::s4u::Exec::test()`") - .def("cancel", [](simgrid::s4u::ExecPtr self) { self->cancel(); }, - "Cancel that execution, see :cpp:func:`simgrid::s4u::Exec::cancel()`") - .def("start", [](simgrid::s4u::ExecPtr self) { return self->start(); }, - "Start that execution, see :cpp:func:`simgrid::s4u::Exec::start()`") - .def("wait", [](simgrid::s4u::ExecPtr self) { return self->wait(); }, - "Block until the completion of that execution, see :cpp:func:`simgrid::s4u::Exec::wait()`"); + py::class_(m, "Exec", "Execution") + .def_property_readonly( + "remaining", + [](simgrid::s4u::ExecPtr self) { + GilScopedRelease gil_guard; + return self->get_remaining(); + }, + "Amount of flops that remain to be computed until completion.") + .def_property_readonly( + "remaining_ratio", + [](simgrid::s4u::ExecPtr self) { + GilScopedRelease gil_guard; + return self->get_remaining_ratio(); + }, + "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done " + "yet).") + .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.") + .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("wait", &simgrid::s4u::Exec::wait, py::call_guard(), + "Block until the completion of that execution."); /* Class Actor */ py::class_(m, "Actor", "An actor is an independent stream of execution in your distributed " - "application, see :ref:`class s4u::Actor `") - .def("create", - [](py::str name, Host* host, py::object fun, py::args args) { - return simgrid::s4u::Actor::create(name, host, [fun, args]() { - try { - fun(*args); - } catch (const py::error_already_set& ex) { - if (ex.matches(pyForcefulKillEx)) { - XBT_VERB("Actor killed"); - /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */ - } else { - throw; - } - } - }); - }, - "Create an actor from a function or an object.") - .def_property("host", &Actor::get_host, &Actor::set_host, "The host on which this actor is located") + "application") + .def( + "create", + [](py::str name, Host* host, 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, host, [fun, args]() { + GilScopedAcquire py_context; + try { + fun(*args); + } catch (const py::error_already_set& ex) { + bool ffk = ex.matches(pyForcefulKillEx); + py_context.reset(); + if (ffk) { + XBT_VERB("Actor killed"); + simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception + } + throw; + } + }); + }, + py::call_guard(), "Create an actor from a function or an object.") + .def_property( + "host", &Actor::get_host, + [](Actor* a, Host* h) { + GilScopedRelease gil_guard; + a->set_host(h); + }, + "The host on which this actor is located") .def_property_readonly("name", &Actor::get_cname, "The name of this actor.") .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.") .def_property_readonly("ppid", &Actor::get_ppid, "The PID (unique identifier) of the actor that created this one.") .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID") - .def("daemonize", &Actor::daemonize, + .def("daemonize", &Actor::daemonize, py::call_guard(), "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ " "documentation).") .def("is_daemon", &Actor::is_daemon, "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor " "terminates.") - .def("join", py::overload_cast(&Actor::join), + .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", [](ActorPtr act) { act->kill(); }, "Kill that actor") - .def("kill_all", &Actor::kill_all, "Kill all actors but the caller.") + .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, "Suspend that actor, that is blocked until resume()ed by another actor.") - .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed."); + .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."); }