+ /* Class Split-Duplex Link */
+ py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
+ m, "SplitDuplexLink", "Network split-duplex link")
+ .def("get_link_up",
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(PyExc_DeprecationWarning,
+ "get_link_up() is deprecated and will be dropped after v3.33, use link_up instead.", 1);
+ return self.attr("link_up");
+ })
+ .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
+ .def("get_link_down",
+ [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+ {
+ PyErr_WarnEx(PyExc_DeprecationWarning,
+ "get_link_down() is deprecated and will be dropped after v3.33, use link_down instead.", 1);
+ return self.attr("link_down");
+ })
+ .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
+
+ /* Class Mailbox */
+ py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
+ m, "Mailbox", "Mailbox. See the C++ documentation for details.")
+ .def(
+ "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
+ "Textual representation of the Mailbox`")
+ .def_static("by_name", &Mailbox::by_name,
+ py::call_guard<py::gil_scoped_release>(),
+ 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(
+ "put",
+ [](Mailbox* self, py::object data, int size, double timeout) {
+ data.inc_ref();
+ self->put(data.ptr(), size, timeout);
+ },
+ py::call_guard<py::gil_scoped_release>(), "Blocking data transmission with a timeout")
+ .def(
+ "put",
+ [](Mailbox* self, py::object data, int size) {
+ data.inc_ref();
+ self->put(data.ptr(), size);
+ },
+ py::call_guard<py::gil_scoped_release>(), "Blocking data transmission")
+ .def(
+ "put_async",
+ [](Mailbox* self, py::object data, int size) {
+ data.inc_ref();
+ return self->put_async(data.ptr(), size);
+ },
+ py::call_guard<py::gil_scoped_release>(), "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<py::gil_scoped_release>(),
+ "Creates (but don’t start) a data transmission to that mailbox.")
+ .def(
+ "get",
+ [](Mailbox* self) {
+ py::object data = py::reinterpret_steal<py::object>(self->get<PyObject>());
+ // data.dec_ref(); // FIXME: why does it break python-actor-create?
+ return data;
+ },
+ py::call_guard<py::gil_scoped_release>(), "Blocking data reception")
+ .def(
+ "get_async",
+ [](Mailbox* self) -> std::tuple<simgrid::s4u::CommPtr, PyGetAsync> {
+ PyGetAsync wrap;
+ auto comm = self->get_async(wrap.get());
+ return std::make_tuple(std::move(comm), std::move(wrap));
+ },
+ py::call_guard<py::gil_scoped_release>(),
+ "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
+ .def(
+ "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); },
+ py::call_guard<py::gil_scoped_release>(), "Sets the actor as permanent receiver");
+
+ /* Class PyGetAsync */
+ py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
+ .def(py::init<>())
+ .def(
+ "get", [](const PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
+ "Get python object after async communication in receiver side");
+
+ /* Class Comm */
+ py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
+ "Communication. See the C++ documentation for details.")
+ .def("test", &simgrid::s4u::Comm::test, py::call_guard<py::gil_scoped_release>(),
+ "Test whether the communication is terminated.")
+ .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of that communication.")
+ .def("wait_for", &simgrid::s4u::Comm::wait_for,
+ py::arg("timeout"),
+ py::call_guard<py::gil_scoped_release>(),
+ "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<py::gil_scoped_release>(),
+ "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<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
+ py::arg("comms"),
+ py::call_guard<py::gil_scoped_release>(),
+ "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<py::gil_scoped_release>(),
+ "Block until the completion of all communications in the list, or raises TimeoutException after "
+ "the specified timeout.")
+ .def_static(
+ "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
+ py::arg("comms"),
+ py::call_guard<py::gil_scoped_release>(),
+ "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<const std::vector<simgrid::s4u::CommPtr>&, double>(&simgrid::s4u::Comm::wait_any_for),
+ py::arg("comms"), py::arg("timeout"),
+ py::call_guard<py::gil_scoped_release>(),
+ "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_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities. See the C++ documentation for details.")
+ .def("test", &simgrid::s4u::Io::test, py::call_guard<py::gil_scoped_release>(),
+ "Test whether the I/O is terminated.")
+ .def("wait", &simgrid::s4u::Io::wait, py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of that I/O operation")
+ .def_static(
+ "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.")
+ .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of any I/O in the list and return the index of the terminated one.");
+
+ /* Class Exec */
+ py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution. See the C++ documentation for details.")
+ .def_property_readonly(
+ "remaining",
+ [](simgrid::s4u::ExecPtr self) {
+ py::gil_scoped_release gil_guard;
+ return self->get_remaining();
+ },
+ "Amount of flops that remain to be computed until completion (read-only property).")
+ .def_property_readonly(
+ "remaining_ratio",
+ [](simgrid::s4u::ExecPtr self) {
+ py::gil_scoped_release gil_guard;
+ return self->get_remaining_ratio();
+ },
+ "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
+ "yet) (read-only property).")
+ .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
+ "Host on which this execution runs. Only the first host is returned for parallel executions. "
+ "Changing this value migrates the execution.")
+ .def("test", &simgrid::s4u::Exec::test, py::call_guard<py::gil_scoped_release>(),
+ "Test whether the execution is terminated.")
+ .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<py::gil_scoped_release>(), "Cancel that execution.")
+ .def("start", &simgrid::s4u::Exec::start, py::call_guard<py::gil_scoped_release>(), "Start that execution.")
+ .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<py::gil_scoped_release>(),
+ "Block until the completion of that execution.");
+
+ /* Class Mutex */
+ py::class_<Mutex, MutexPtr>(m, "Mutex",
+ "A classical mutex, but blocking in the simulation world."
+ "See the C++ documentation for details.")
+ .def(py::init<>(&Mutex::create))
+ .def("lock", &Mutex::lock, py::call_guard<py::gil_scoped_release>(), "Block until the mutex is acquired.")
+ .def("try_lock", &Mutex::try_lock, py::call_guard<py::gil_scoped_release>(),
+ "Try to acquire the mutex. Return true if the mutex was acquired, false otherwise.")
+ .def("unlock", &Mutex::unlock, py::call_guard<py::gil_scoped_release>(), "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<py::gil_scoped_release>())
+ .def("__exit__", [](Mutex* self, py::object&, py::object&, py::object&){ self->unlock(); },
+ py::call_guard<py::gil_scoped_release>());
+
+ /* Class Barrier */
+ py::class_<Barrier, BarrierPtr>(m, "Barrier",
+ "A classical barrier, but blocking in the simulation world.")
+ .def(py::init<>(&Barrier::create), py::call_guard<py::gil_scoped_release>(), py::arg("expected_actors"))
+ .def("wait", &Barrier::wait, py::call_guard<py::gil_scoped_release>(),
+ "Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches "
+ "the barrier");
+
+ /* Class Actor */
+ py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
+ "An actor is an independent stream of execution in your distributed "
+ "application. See the C++ documentation for details.")
+ .def(
+ "create",
+ [](py::str name, Host* h, py::object fun, py::args args) {
+ fun.inc_ref(); // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
+ args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
+ return simgrid::s4u::Actor::create(name, h, [fun, args]() {
+ py::gil_scoped_acquire py_context;
+ try {
+ fun(*args);
+ } catch (const py::error_already_set& ex) {
+ if (ex.matches(pyForcefulKillEx)) {
+ XBT_VERB("Actor killed");
+ simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
+ }
+ throw;
+ }
+ });
+ },
+ py::call_guard<py::gil_scoped_release>(),
+ "Create an actor from a function or an object. See the :ref:`example <s4u_ex_actors_create>`.")
+ .def_property(
+ "host", &Actor::get_host,
+ [](Actor* a, Host* h) {
+ py::gil_scoped_release gil_guard;
+ a->set_host(h);
+ },
+ "The host on which this actor is located. Changing this value migrates the actor.\n\n"
+ "If the actor is currently blocked on an execution activity, the activity is also migrated to the new host. "
+ "If it’s blocked on another kind of activity, an error is raised as the mandated code is not written yet. "
+ "Please report that bug if you need it.\n\n"
+ "Asynchronous activities started by the actor are not migrated automatically, so you have to take care of "
+ "this yourself (only you knows which ones should be migrated). ")
+ .def_property_readonly("name", &Actor::get_cname, "The name of this actor (read-only property).")
+ .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_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<py::gil_scoped_release>(),
+ "Specify whether the actor shall restart when its host reboots.")
+ .def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
+ "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<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
+ "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout") = -1)
+ .def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "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.")
+ .def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
+ "Suspend that actor, that is blocked until resume()ed by another actor.")
+ .def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
+ "Resume that actor, that was previously suspend()ed.")
+ .def_static("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "Kill all actors but the caller.");