X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4de2a148bea34f550b79c07fb5e80ac36e6aa0e9..cf0167eb459e9cae60188cbc9f9a7c126d857b08:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index 60ce5f652f..db71ba46d9 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,18 @@ namespace py = pybind11; using simgrid::s4u::Actor; using simgrid::s4u::ActorPtr; +using simgrid::s4u::Barrier; +using simgrid::s4u::BarrierPtr; +using simgrid::s4u::Comm; +using simgrid::s4u::CommPtr; 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"); @@ -110,6 +120,8 @@ PYBIND11_MODULE(simgrid, m) py::arg("priority") = 1) .def("exec_init", py::overload_cast(&simgrid::s4u::this_actor::exec_init), py::call_guard()) + .def("exec_async", py::overload_cast(&simgrid::s4u::this_actor::exec_async), + 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")) @@ -174,6 +186,8 @@ PYBIND11_MODULE(simgrid, m) "get_all_hosts() is deprecated and will be dropped after v3.33, use all_hosts instead.", 1); return self.attr("all_hosts"); }) + .def("host_by_name", &Engine::host_by_name_or_null, py::call_guard(), + "Retrieve a host by its name, or None if it does not exist in the platform.") .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform") .def("get_all_links", [](py::object self) // XBT_ATTRIB_DEPRECATED_v334 @@ -206,6 +220,10 @@ PYBIND11_MODULE(simgrid, m) .def("netzone_by_name", &Engine::netzone_by_name_or_null) .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("mailbox_by_name_or_create", &Engine::mailbox_by_name_or_create, + py::call_guard(), + py::arg("name"), + "Find a mailbox from its name or create one if it does not exist") .def("run", &Engine::run, py::call_guard(), "Run the simulation until its end") .def("run_until", py::overload_cast(&Engine::run_until, py::const_), py::call_guard(), "Run the simulation until the given date", @@ -318,7 +336,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) { @@ -424,7 +442,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", @@ -443,7 +461,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) { @@ -627,13 +645,18 @@ 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) { return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC }, "The name of that mailbox (read-only property).") + .def_property_readonly("ready", &Mailbox::ready, py::call_guard(), + "Check if there is a communication ready to be consumed from a mailbox.") .def( "put", [](Mailbox* self, py::object data, int size, double timeout) { @@ -673,7 +696,7 @@ PYBIND11_MODULE(simgrid, m) py::call_guard(), "Blocking data reception") .def( "get_async", - [](Mailbox* self) -> std::tuple { + [](Mailbox* self) -> std::tuple { PyGetAsync wrap; auto comm = self->get_async(wrap.get()); return std::make_tuple(std::move(comm), std::move(wrap)); @@ -692,46 +715,93 @@ PYBIND11_MODULE(simgrid, m) "Get python object after async communication in receiver side"); /* Class Comm */ - py::class_(m, "Comm", - "Communication. See the C++ documentation for details.") - .def("test", &simgrid::s4u::Comm::test, py::call_guard(), + py::class_(m, "Comm", "Communication. See the C++ documentation for details.") + .def_property_readonly("dst_data_size", &Comm::get_dst_data_size, + py::call_guard(), + "Retrieve the size of the received data.") + .def_property_readonly("mailbox", &Comm::get_mailbox, + py::call_guard(), + "Retrieve the mailbox on which this comm acts.") + .def_property_readonly("sender", &Comm::get_sender, + py::call_guard()) + .def_property_readonly("state_str", [](const Comm* self){ return std::string(self->get_state_str()); }, + py::call_guard(), + "Retrieve the Comm state as string") + .def_property_readonly("remaining", &Comm::get_remaining, + py::call_guard(), + "Remaining amount of work that this Comm entails") + .def_property_readonly("start_time", &Comm::get_start_time, + py::call_guard(), + "Time at which this Comm started") + .def_property_readonly("finish_time", &Comm::get_finish_time, + py::call_guard(), + "Time at which this Comm finished") + .def("set_payload_size", &Comm::set_payload_size, py::call_guard(), + py::arg("bytes"), + "Specify the amount of bytes which exchange should be simulated.") + .def("set_rate", &Comm::set_rate, py::call_guard(), + py::arg("rate"), + "Sets the maximal communication rate (in byte/sec). Must be done before start") + .def("cancel", [](Comm* self){ return self->cancel(); }, + py::call_guard(), py::return_value_policy::reference_internal, + "Cancel the activity.") + .def("start", [](Comm* self){ return self->start(); }, + py::call_guard(), py::return_value_policy::reference_internal, + "Starts a previously created activity. This function is optional: you can call wait() even if you didn't " + "call start()") + .def("suspend", [](Comm* self){ return self->suspend(); }, + py::call_guard(), py::return_value_policy::reference_internal, + "Suspend the activity.") + .def("resume", [](Comm* self){ return self->resume(); }, + py::call_guard(), py::return_value_policy::reference_internal, + "Resume the activity.") + .def("test", &Comm::test, py::call_guard(), "Test whether the communication is terminated.") - .def("wait", &simgrid::s4u::Comm::wait, py::call_guard(), + .def("wait", &Comm::wait, py::call_guard(), "Block until the completion of that communication.") - .def("wait_for", &simgrid::s4u::Comm::wait_for, + .def("wait_for", &Comm::wait_for, py::call_guard(), 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(); - }, + .def("wait_until", &Comm::wait_until, py::call_guard(), + py::arg("time_limit"), + "Block until the completion of that communication, or raises TimeoutException after the specified time.") + .def("detach", [](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::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"), + .def_static("sendto", &Comm::sendto, py::call_guard(), + py::arg("from"), py::arg("to"), py::arg("simulated_size_in_bytes"), + "Do a blocking communication between two arbitrary hosts.") + .def_static("sendto_init", py::overload_cast(&Comm::sendto_init), + py::call_guard(), + py::arg("from"), py::arg("to"), + "Creates a communication between the two given hosts, bypassing the mailbox mechanism.") + .def_static("sendto_async", &Comm::sendto_async, py::call_guard(), + py::arg("from"), py::arg("to"), py::arg("simulated_size_in_bytes"), + "Do a blocking communication between two arbitrary hosts.\n\nThis initializes a communication that " + "completely bypass the mailbox and actors mechanism. There is really no limit on the hosts involved. " + "In particular, the actor does not have to be on one of the involved hosts.") + .def_static("test_any", &Comm::test_any, py::call_guard(), + py::arg("comms"), + "take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done)") + .def_static("wait_all", &Comm::wait_all, py::call_guard(), + py::arg("comms"), + "Block until the completion of all communications in the list.") + .def_static("wait_all_for", &Comm::wait_all_for, py::call_guard(), + py::arg("comms"), py::arg("timeout"), "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." - ); + .def_static("wait_any", &Comm::wait_any, + py::call_guard(), + py::arg("comms"), + "Block until the completion of any communication in the list and return the index of the " + "terminated one.") + .def_static("wait_any_for", &Comm::wait_any_for, + py::call_guard(), + py::arg("comms"), py::arg("timeout"), + "Block until the completion of any communication in the list and return the index of the terminated " + "one, or -1 if a timeout occurred."); /* Class Io */ py::class_(m, "Io", "I/O activities. See the C++ documentation for details.") @@ -772,6 +842,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 " @@ -812,7 +927,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(), @@ -822,7 +937,7 @@ 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("self", &Actor::self, "Retrieves the current actor.") .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")