#include "simgrid/kernel/ProfileBuilder.hpp"
#include "simgrid/kernel/routing/NetPoint.hpp"
-#include "src/kernel/context/Context.hpp"
#include <simgrid/Exception.hpp>
#include <simgrid/s4u/Actor.hpp>
#include <simgrid/s4u/Comm.hpp>
"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<double, double>(&simgrid::s4u::this_actor::execute),
[](py::object cb) {
py::function fun = py::reinterpret_borrow<py::function>(cb);
fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
- simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
+ simgrid::s4u::this_actor::on_exit([fun](bool failed) {
py::gil_scoped_acquire py_context; // need a new context for callback
try {
- fun();
+ fun(failed);
} catch (const py::error_already_set& e) {
xbt_die("Error while executing the on_exit lambda: %s", e.what());
}
});
},
- py::call_guard<py::gil_scoped_release>(), "")
+ py::call_guard<py::gil_scoped_release>(),
+ "Define a lambda to be called when the actor ends. It takes a bool parameter indicating whether the actor "
+ "was killed. If False, the actor finished peacefully.")
.def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
.def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
"Retrieves PPID of the current actor (i.e., the PID of its parent).");
.def_static("get_clock",
[]() // XBT_ATTRIB_DEPRECATED_v334
{
- PyErr_WarnEx(PyExc_DeprecationWarning,
- "get_clock() is deprecated and will be dropped after v3.33, use clock instead.", 1);
+ PyErr_WarnEx(
+ PyExc_DeprecationWarning,
+ "get_clock() is deprecated and will be dropped after v3.33, use `Engine.clock` instead.", 1);
return Engine::get_clock();
})
.def_property_readonly_static(
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) {
"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::call_guard<py::gil_scoped_release>(), "Block until the completion of all communications in the list.")
+ 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.");
+ "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("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"))
.def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
- .def("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "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<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.");
+ "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.");
}
