X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c8f375f14b9e04a4dd1767cb70c70b6dfc173f9c..7ebcb30a599c0b1486cc2e523bd48b516652f916:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 533d61f465..c724dbb490 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2018-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2018-2020. 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. */ @@ -44,8 +44,6 @@ using simgrid::s4u::Mailbox; XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python"); -PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr) - namespace { static std::string get_simgrid_version() @@ -57,40 +55,45 @@ static std::string get_simgrid_version() return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch); } -static std::string simgrid_version = get_simgrid_version(); - } // namespace +PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr) + PYBIND11_MODULE(simgrid, m) { m.doc() = "SimGrid userspace API"; - m.attr("simgrid_version") = simgrid_version; + m.attr("simgrid_version") = get_simgrid_version(); // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack) 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 + void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload void (*sleep_until_fun)(double) = &simgrid::s4u::this_actor::sleep_until; 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("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("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", 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, - "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( + "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, "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"); @@ -119,7 +122,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_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()`") @@ -154,43 +158,63 @@ PYBIND11_MODULE(simgrid, m) "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 `") + 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("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. This is the max potential speed. See :cpp:func:`simgrid::s4u::Host::get_speed()`"); + .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) -> 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. " + "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) { - 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) -> 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()`"); + py::class_>( + m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox `") + .def("__str__", + [](const 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", + [](const 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) { + 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) -> 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", @@ -199,35 +223,41 @@ PYBIND11_MODULE(simgrid, m) "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); }, + .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", [](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("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()`"); + + /* 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()`") + "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()`") + "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::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()`") + "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()`") + "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()`") + "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()`") + "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()`"); + "Block until the completion of that execution, see :cpp:func:`simgrid::s4u::Exec::wait()`"); /* Class Actor */ py::class_(m, "Actor",