X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/460c1afae0329ce01f6c3e7f9131ffe845be0cb4..992c3a8621f205aedc022a0d5a5d3fc7bb75e6a1:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 3d2fa256bb..d08e791dca 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -24,9 +24,9 @@ #include "simgrid/kernel/ProfileBuilder.hpp" #include "simgrid/kernel/routing/NetPoint.hpp" -#include "src/kernel/context/Context.hpp" #include #include +#include #include #include #include @@ -34,7 +34,9 @@ #include #include #include +#include #include +#include #include #include @@ -45,10 +47,16 @@ namespace py = pybind11; using simgrid::s4u::Actor; using simgrid::s4u::ActorPtr; +using simgrid::s4u::Barrier; +using simgrid::s4u::BarrierPtr; using simgrid::s4u::Engine; using simgrid::s4u::Host; using simgrid::s4u::Link; using simgrid::s4u::Mailbox; +using simgrid::s4u::Mutex; +using simgrid::s4u::MutexPtr; +using simgrid::s4u::Semaphore; +using simgrid::s4u::SemaphorePtr; XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python"); @@ -100,6 +108,8 @@ PYBIND11_MODULE(simgrid, m) "debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.") .def( "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.") + .def( + "warning", [](const char* s) { XBT_WARN("%s", s); }, "Display a logging message of 'warning' 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), @@ -316,7 +326,7 @@ PYBIND11_MODULE(simgrid, m) /* Class Host */ py::class_> host( m, "Host", "Simulated host. See the C++ documentation for details."); - host.def("by_name", &Host::by_name, "Retrieves a host from its name, or die") + host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die") .def( "route_to", [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) { @@ -422,7 +432,7 @@ PYBIND11_MODULE(simgrid, m) h->set_pstate(i); }, "The current pstate (read/write property).") - .def("current", &Host::current, py::call_guard(), + .def_static("current", &Host::current, py::call_guard(), "Retrieves the host on which the running actor is located.") .def_property_readonly( "name", @@ -441,7 +451,7 @@ PYBIND11_MODULE(simgrid, m) "Get the available speed ratio, between 0 and 1.\n" "This accounts for external load (see :py:func:`set_speed_profile() " "`) (read-only property).") - .def( + .def_static( "on_creation_cb", [](py::object cb) { Host::on_creation_cb([cb](Host& h) { @@ -625,7 +635,10 @@ PYBIND11_MODULE(simgrid, m) .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_static("by_name", &Mailbox::by_name, + py::call_guard(), + py::arg("name"), + "Retrieve a Mailbox from its name") .def_property_readonly( "name", [](const Mailbox* self) { @@ -653,6 +666,14 @@ PYBIND11_MODULE(simgrid, m) return self->put_async(data.ptr(), size); }, py::call_guard(), "Non-blocking data transmission") + .def( + "put_init", + [](Mailbox* self, py::object data, int size) { + data.inc_ref(); + return self->put_init(data.ptr(), size); + }, + py::call_guard(), + "Creates (but don’t start) a data transmission to that mailbox.") .def( "get", [](Mailbox* self) { @@ -689,19 +710,35 @@ PYBIND11_MODULE(simgrid, m) .def("wait", &simgrid::s4u::Comm::wait, py::call_guard(), "Block until the completion of that communication.") .def("wait_for", &simgrid::s4u::Comm::wait_for, + py::arg("timeout"), py::call_guard(), "Block until the completion of that communication, or raises TimeoutException after the specified timeout.") + .def("detach", [](simgrid::s4u::Comm* self) { + return self->detach(); + }, + py::return_value_policy::reference_internal, + py::call_guard(), + "Start the comm, and ignore its result. It can be completely forgotten after that.") // 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.") + py::arg("comms"), + py::call_guard(), + "Block until the completion of all communications in the list.") + .def_static("wait_all_for", &simgrid::s4u::Comm::wait_all_for, + py::arg("comms"), py::arg("timeout"), + py::call_guard(), + "Block until the completion of all communications in the list, or raises TimeoutException after " + "the specified timeout.") .def_static( "wait_any", py::overload_cast&>(&simgrid::s4u::Comm::wait_any), + py::arg("comms"), py::call_guard(), "Block until the completion of any communication in the list and return the index of the terminated one.") .def_static( "wait_any_for", py::overload_cast&, double>(&simgrid::s4u::Comm::wait_any_for), + py::arg("comms"), py::arg("timeout"), py::call_guard(), "Block until the completion of any communication in the list and return the index of the terminated " "one, or -1 if a timeout occurred." @@ -746,6 +783,51 @@ PYBIND11_MODULE(simgrid, m) .def("wait", &simgrid::s4u::Exec::wait, py::call_guard(), "Block until the completion of that execution."); + /* Class Semaphore */ + py::class_(m, "Semaphore", + "A classical semaphore, but blocking in the simulation world. See the C++ " + "documentation for details.") + .def(py::init<>(&Semaphore::create), py::call_guard(), py::arg("capacity"), + "Semaphore constructor.") + .def("acquire", &Semaphore::acquire, py::call_guard(), + "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired.") + .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_property_readonly("capacity", &Semaphore::get_capacity, py::call_guard(), + "Get the semaphore capacity.") + .def_property_readonly("would_block", &Semaphore::would_block, py::call_guard(), + "Check whether trying to acquire the semaphore would block (in other word, checks whether " + "this semaphore has capacity).") + // Allow semaphores to be automatically acquired/released with a context manager: `with semaphore: ...` + .def("__enter__", [](Semaphore* self){ self->acquire(); }, py::call_guard()) + .def("__exit__", [](Semaphore* self){ self->release(); }, py::call_guard()); + + /* Class Mutex */ + 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("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* self){ self->lock(); }, 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.") + .def(py::init<>(&Barrier::create), py::call_guard(), py::arg("expected_actors"), + "Barrier constructor.") + .def("wait", &Barrier::wait, py::call_guard(), + "Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches " + "the barrier."); + /* Class Actor */ py::class_(m, "Actor", "An actor is an independent stream of execution in your distributed " @@ -786,7 +868,7 @@ PYBIND11_MODULE(simgrid, m) .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).") .def_property_readonly("ppid", &Actor::get_ppid, "The PID (unique identifier) of the actor that created this one (read-only property).") - .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID") + .def_static("by_pid", &Actor::by_pid, py::arg("pid"), "Retrieve an actor by its PID") .def("set_auto_restart", &Actor::set_auto_restart, py::call_guard(), "Specify whether the actor shall restart when its host reboots.") .def("daemonize", &Actor::daemonize, py::call_guard(), @@ -796,13 +878,13 @@ PYBIND11_MODULE(simgrid, m) "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, py::const_), py::call_guard(), - "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout")) + "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout") = -1) .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, 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."); + "Resume that actor, that was previously suspend()ed.") + .def_static("kill_all", &Actor::kill_all, py::call_guard(), "Kill all actors but the caller."); }