X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5fb8ddb0f5fa89e99955ac4500a6fd4631fe401b..e79bb207ca282597360b3c23facee4b50c749233:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 4a67d2eb6e..b8301ada04 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -8,15 +8,28 @@ #define _hypot hypot #endif +#if defined(__GNUG__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wunused-value" +#endif + #include #include // Must come before our own stuff #include +#if defined(__GNUG__) +#pragma GCC diagnostic pop +#endif + #include "src/kernel/context/Context.hpp" +#include #include +#include #include +#include #include #include +#include #include #include @@ -31,7 +44,7 @@ using simgrid::s4u::Mailbox; XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python"); -PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr); +PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr) namespace { @@ -56,7 +69,7 @@ PYBIND11_MODULE(simgrid, m) m.attr("simgrid_version") = simgrid_version; // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack) - py::object pyStopRequestEx = py::register_exception(m, "ActorKilled"); + static py::object pyForcefulKillEx(py::register_exception(m, "ActorKilled")); /* this_actor namespace */ void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload @@ -69,9 +82,11 @@ PYBIND11_MODULE(simgrid, m) "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("migrate", &simgrid::s4u::this_actor::migrate, "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::migrate()`", - py::arg("dest")); + 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", sleep_for_fun, "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", sleep_until_fun, @@ -83,15 +98,13 @@ PYBIND11_MODULE(simgrid, m) m2.def("on_exit", [](py::object fun) { ActorPtr act = Actor::self(); - simgrid::s4u::this_actor::on_exit( - [act, fun](int /*ignored*/, void* /*data*/) { - try { - fun(); - } catch (py::error_already_set& e) { - xbt_die("Error while executing the on_exit lambda: %s", e.what()); - } - }, - nullptr); + simgrid::s4u::this_actor::on_exit([act, fun](bool /*failed*/) { + try { + fun(); + } catch (py::error_already_set& e) { + xbt_die("Error while executing the on_exit lambda: %s", e.what()); + } + }); }, ""); @@ -107,8 +120,8 @@ PYBIND11_MODULE(simgrid, m) // Currently this can be dangling, we should wrap this somehow. return new simgrid::s4u::Engine(&argc, argv.get()); })) + .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("get_clock", &Engine::get_clock, "Retrieve the simulation time (in seconds)") .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, @@ -116,96 +129,147 @@ PYBIND11_MODULE(simgrid, m) ":cpp:func:`simgrid::s4u::Engine::load_deployment()`") .def("run", &Engine::run, "Run the simulation") .def("register_actor", - [pyStopRequestEx](Engine*, std::string name, py::object fun_or_class) { - simgrid::simix::register_function( - name, [pyStopRequestEx, fun_or_class](std::vector args) -> simgrid::simix::ActorCode { - return [pyStopRequestEx, fun_or_class, 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 (py::error_already_set& ex) { - if (ex.matches(pyStopRequestEx)) { - XBT_VERB("Actor killed"); - /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */ - } else { - throw; - } - } - }; - }); + [](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 (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_function()`"); + "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_actor()`"); /* 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", [](Host* self) -> const std::string { 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()`") .def_property_readonly("speed", &Host::get_speed, - "The peak computing speed in flops/s at the current pstate, taking the external load into account, see :cpp:func:`simgrid::s4u::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()`"); /* Class Mailbox */ py::class_>(m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox `") + .def("__str__", [](Mailbox* self) -> const std::string { + 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", [](Mailbox* self) -> const std::string { 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) { + .def("put", [](Mailbox* self, py::object data, int size) { data.inc_ref(); - self.put(data.ptr(), size); + self->put(data.ptr(), size); }, "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`") - .def("get", [](Mailbox self) -> py::object { - py::object data = pybind11::reinterpret_steal(pybind11::handle(static_cast(self.get()))); + .def("put_async", [](Mailbox* self, py::object data, int size) -> simgrid::s4u::CommPtr { + 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 { + 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()`"); + /* 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", [](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", [](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, "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()`"); + /* 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", - [pyStopRequestEx](py::str name, py::object host, py::object fun, py::args args) { + [](py::str name, py::object host, py::object fun, py::args args) { - return simgrid::s4u::Actor::create(name, host.cast(), [fun, args, pyStopRequestEx]() { + return simgrid::s4u::Actor::create(name, host.cast(), [fun, args]() { try { fun(*args); } catch (py::error_already_set& ex) { - if (ex.matches(pyStopRequestEx)) { + if (ex.matches(pyForcefulKillEx)) { XBT_VERB("Actor killed"); - /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */ + /* 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, see :cpp:func:`simgrid::s4u::Actor::create()`") - .def_property("host", &Actor::get_host, &Actor::migrate, "The host on which this actor is located") + "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") + .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, - "This actor will be automatically terminated when the last non-daemon actor finishes, see :cpp:func:`void " - "simgrid::s4u::Actor::daemonize()`") + "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), - "Wait for the actor to finish, see :cpp:func:`void simgrid::s4u::Actor::join(double)`", py::arg("timeout")) + "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("migrate", &Actor::migrate, - "Moves that actor to another host, see :cpp:func:`void simgrid::s4u::Actor::migrate()`", py::arg("dest")) - .def("self", &Actor::self, "Retrieves the current actor, see :cpp:func:`void simgrid::s4u::Actor::self()`") + .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.");