X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4724bddcd04a5531a88dd84f798b4c8cc7f1bd00..59293d52a1b80ddb306c6282fd32624dbd042271:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 1a02f46d0a..ba89c6ec3b 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -1,17 +1,26 @@ -/* Copyright (c) 2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2018-2019. 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. */ +#ifdef _WIN32 +#warning Try to work around https://bugs.python.org/issue11566 +#define _hypot hypot +#endif + +#include +#include // Must come before our own stuff +#include + #include "src/kernel/context/Context.hpp" +#include #include +#include +#include #include #include #include -#include -#include - #include #include #include @@ -31,7 +40,9 @@ namespace { static std::string get_simgrid_version() { - int major, minor, patch; + int major; + int minor; + int patch; sg_version_get(&major, &minor, &patch); return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch); } @@ -48,7 +59,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"); + 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 @@ -56,11 +67,13 @@ PYBIND11_MODULE(simgrid, m) py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace."); m2.def("info", [](char* s) { XBT_INFO("%s", s); }, "Display a logging message of default priority."); + m2.def("error", [](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("get_host", &simgrid::s4u::this_actor::get_host, "Retrives host on which the current actor is located"); + 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("sleep_for", sleep_for_fun, @@ -70,7 +83,19 @@ PYBIND11_MODULE(simgrid, m) 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); + 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 (py::error_already_set& e) { + xbt_die("Error while executing the on_exit lambda: %s", e.what()); + } + }); + }, + ""); /* Class Engine */ py::class_(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine `") @@ -84,8 +109,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") .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, @@ -93,10 +118,10 @@ 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) { + [pyForcefulKillEx](Engine*, const 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]() { + name, [pyForcefulKillEx, fun_or_class](std::vector args) -> simgrid::simix::ActorCode { + return [pyForcefulKillEx, fun_or_class, args]() { try { /* Convert the std::vector into a py::tuple */ py::tuple params(args.size() - 1); @@ -109,9 +134,9 @@ PYBIND11_MODULE(simgrid, m) if (py::isinstance(res)) res(); } 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; } @@ -124,45 +149,95 @@ PYBIND11_MODULE(simgrid, m) /* 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(pybind11::handle(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) { + [pyForcefulKillEx](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, pyForcefulKillEx]() { 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; } @@ -171,11 +246,15 @@ PYBIND11_MODULE(simgrid, m) }, "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") + .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.") + .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()`") .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")) + .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()`")