+ .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()`")
+ .def("load_deployment", &Engine::load_deployment,
+ "Load a deployment file and launch the actors that it contains, see "
+ ":cpp:func:`simgrid::s4u::Engine::load_deployment()`")
+ .def("run", &Engine::run, py::call_guard<GilScopedRelease>(), "Run the simulation")
+ .def("register_actor",
+ [](Engine* e, const std::string& name, py::object fun_or_class) {
+ e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
+ GilScopedAcquire py_context;
+ try {
+ /* Convert the std::vector into a py::tuple */
+ py::tuple params(args.size() - 1);
+ for (size_t i = 1; i < args.size(); i++)
+ params[i - 1] = py::cast(args[i]);
+
+ py::object res = fun_or_class(*params);
+
+ /* If I was passed a class, I just built an instance, so I need to call it now */
+ if (py::isinstance<py::function>(res))
+ res();
+ } catch (const py::error_already_set& ex) {
+ bool ffk = ex.matches(pyForcefulKillEx);
+ py_context.reset();
+ if (ffk) {
+ XBT_VERB("Actor killed");
+ /* Forward that ForcefulKill exception */
+ simgrid::ForcefulKillException::do_throw();
+ }
+ throw;
+ }
+ });
+ },
+ "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_actor()`");
+
+ /* Class Host */
+ py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(
+ m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_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_property("pstate", &Host::get_pstate,
+ [](Host* h, int i) {
+ GilScopedRelease gil_guard;
+ h->set_pstate(i);
+ },
+ "The current pstate")
+ .def("current", &Host::current, py::call_guard<GilScopedRelease>(),
+ "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
+ .def_property_readonly("name",
+ [](const Host* self) {
+ 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_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
+ m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
+ .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<GilScopedRelease>(),
+ "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_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, 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);
+ },
+ py::call_guard<GilScopedRelease>(),
+ "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
+ .def("put_async",
+ [](Mailbox* self, py::object data, int size) {
+ data.inc_ref();
+ return self->put_async(data.ptr(), size);
+ },
+ py::call_guard<GilScopedRelease>(),
+ "Non-blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put_async(void*, uint64_t)`")
+ .def("get",
+ [](Mailbox* self) {
+ py::object data = pybind11::reinterpret_steal<py::object>(static_cast<PyObject*>(self->get()));
+ data.dec_ref();
+ return data;
+ },
+ py::call_guard<GilScopedRelease>(),
+ "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
+
+ /* Class Comm */
+ py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
+ "Communication, see :ref:`class s4u::Comm <API_s4u_Comm>`")
+ .def("test", &simgrid::s4u::Comm::test, py::call_guard<GilScopedRelease>(),
+ "Test whether the communication is terminated, see :cpp:func:`simgrid::s4u::Comm::test()`")
+ .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<GilScopedRelease>(),
+ "Block until the completion of that communication, see :cpp:func:`simgrid::s4u::Comm::wait()`")
+ .def("wait_all", &simgrid::s4u::Comm::wait_all, py::call_guard<GilScopedRelease>(),
+ "Block until the completion of all communications in the list, see "
+ ":cpp:func:`simgrid::s4u::Comm::wait_all()`")
+ .def("wait_any", &simgrid::s4u::Comm::wait_any, py::call_guard<GilScopedRelease>(),
+ "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_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec",
+ "Execution, see :ref:`class s4u::Exec <API_s4u_Exec>`")
+ .def_property_readonly("remaining",
+ [](simgrid::s4u::ExecPtr self) {
+ GilScopedRelease gil_guard;
+ return self->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) {
+ GilScopedRelease gil_guard;
+ 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()`")
+ .def_property("host",
+ [](simgrid::s4u::ExecPtr self) {
+ simgrid::s4u::ExecSeqPtr seq = boost::dynamic_pointer_cast<simgrid::s4u::ExecSeq>(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::Exec::set_host,
+ "Host on which this execution runs. See :cpp:func:`simgrid::s4u::ExecSeq::get_host()`")
+ .def("test", &simgrid::s4u::Exec::test, py::call_guard<GilScopedRelease>(),
+ "Test whether the execution is terminated, see :cpp:func:`simgrid::s4u::Exec::test()`")
+ .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<GilScopedRelease>(),
+ "Cancel that execution, see :cpp:func:`simgrid::s4u::Exec::cancel()`")
+ .def("start", &simgrid::s4u::Exec::start, py::call_guard<GilScopedRelease>(),
+ "Start that execution, see :cpp:func:`simgrid::s4u::Exec::start()`")
+ .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<GilScopedRelease>(),
+ "Block until the completion of that execution, see :cpp:func:`simgrid::s4u::Exec::wait()`");
+
+ /* Class Actor */
+ py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
+ "An actor is an independent stream of execution in your distributed "
+ "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
+ .def("create",
+ [](py::str name, Host* host, 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, host, [fun, args]() {
+ GilScopedAcquire py_context;
+ try {
+ fun(*args);
+ } catch (const py::error_already_set& ex) {
+ bool ffk = ex.matches(pyForcefulKillEx);
+ py_context.reset();
+ if (ffk) {
+ XBT_VERB("Actor killed");
+ /* Forward that ForcefulKill exception */
+ simgrid::ForcefulKillException::do_throw();
+ }
+ throw;
+ }
+ });
+ },
+ py::call_guard<GilScopedRelease>(), "Create an actor from a function or an object.")
+ .def_property("host", &Actor::get_host,
+ [](Actor* a, Host* h) {
+ GilScopedRelease gil_guard;
+ a->set_host(h);
+ },
+ "The host on which this actor is located")
+ .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
+ .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
+ .def_property_readonly("ppid", &Actor::get_ppid,
+ "The PID (unique identifier) of the actor that created this one.")
+ .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
+ .def("daemonize", &Actor::daemonize, py::call_guard<GilScopedRelease>(),
+ "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::call_guard<GilScopedRelease>(),
+ "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
+ .def("kill", &Actor::kill, py::call_guard<GilScopedRelease>(), "Kill that actor")
+ .def("kill_all", &Actor::kill_all, py::call_guard<GilScopedRelease>(), "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<GilScopedRelease>(),
+ "Suspend that actor, that is blocked until resume()ed by another actor.")
+ .def("resume", &Actor::resume, py::call_guard<GilScopedRelease>(),
+ "Resume that actor, that was previously suspend()ed.");