-/* Copyright (c) 2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
+#ifdef _WIN32
+#warning Try to work around https://bugs.python.org/issue11566
+#define _hypot hypot
+#endif
+
+#if defined(__GNUG__)
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wunused-value"
+#endif
+
+#include <pybind11/functional.h>
+#include <pybind11/pybind11.h> // Must come before our own stuff
+#include <pybind11/stl.h>
+
+#if defined(__GNUG__)
+#pragma GCC diagnostic pop
+#endif
+
#include "src/kernel/context/Context.hpp"
+#include <simgrid/Exception.hpp>
#include <simgrid/s4u/Actor.hpp>
+#include <simgrid/s4u/Comm.hpp>
#include <simgrid/s4u/Engine.hpp>
+#include <simgrid/s4u/Exec.hpp>
#include <simgrid/s4u/Host.hpp>
#include <simgrid/s4u/Mailbox.hpp>
+#include <simgrid/version.h>
-#include <pybind11/pybind11.h>
-#include <pybind11/stl.h>
-
+#include <algorithm>
#include <memory>
#include <string>
#include <vector>
XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
-PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>);
-
namespace {
-static std::string get_simgrid_version()
+std::string get_simgrid_version()
{
- int major, minor, patch;
+ int major;
+ int minor;
+ int patch;
sg_version_get(&major, &minor, &patch);
return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
}
-static std::string simgrid_version = get_simgrid_version();
+/* Classes GilScopedAcquire and GilScopedRelease have the same purpose as pybind11::gil_scoped_acquire and
+ * pybind11::gil_scoped_release. Refer to the manual of pybind11 for details:
+ * https://pybind11.readthedocs.io/en/stable/advanced/misc.html#global-interpreter-lock-gil
+ *
+ * The pybind11 versions are however too sophisticated (using TLS for example) and don't work well with all kinds of
+ * contexts.
+ * See also https://github.com/pybind/pybind11/issues/1276, which may be related.
+ *
+ * Briefly, GilScopedAcquire can be used on actor creation to acquire a new PyThreadState. The PyThreadState has to be
+ * released for context switches (i.e. before simcalls). That's the purpose of GilScopedRelease.
+ *
+ * Like their pybind11 counterparts, both classes use a RAII pattern.
+ */
+class XBT_PRIVATE GilScopedAcquire {
+ static PyThreadState* acquire()
+ {
+ PyThreadState* state = PyThreadState_New(PyInterpreterState_Head());
+ PyEval_AcquireThread(state);
+ return state;
+ }
+ static void release(PyThreadState* state)
+ {
+ PyEval_ReleaseThread(state);
+ PyThreadState_Clear(state);
+ PyThreadState_Delete(state);
+ }
+
+ std::unique_ptr<PyThreadState, decltype(&release)> thread_state{acquire(), &release};
+
+public:
+ void reset() { thread_state.reset(); }
+};
+
+class XBT_PRIVATE GilScopedRelease {
+ std::unique_ptr<PyThreadState, decltype(&PyEval_RestoreThread)> thread_state{PyEval_SaveThread(),
+ &PyEval_RestoreThread};
+};
} // namespace
+PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
+
PYBIND11_MODULE(simgrid, m)
{
-
m.doc() = "SimGrid userspace API";
- m.attr("simgrid_version") = simgrid_version;
+ m.attr("simgrid_version") = get_simgrid_version();
// Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
- py::object pyStopRequestEx = py::register_exception<simgrid::kernel::context::Context::StopRequest>(m, "ActorKilled");
+ static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
/* this_actor namespace */
- void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload
- void (*sleep_until_fun)(double) = &simgrid::s4u::this_actor::sleep_until;
-
- py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.");
- m2.def("info", [](char* s) { XBT_INFO("%s", s); }, "Display a logging message of default priority.");
- m2.def("error", [](char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.");
- m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
- "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
- "simgrid::s4u::this_actor::execute(double, double)`",
- py::arg("flops"), py::arg("priority") = 1);
- m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrives host on which the current actor is located");
- m2.def("migrate", &simgrid::s4u::this_actor::migrate, "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::migrate()`",
- py::arg("dest"));
- m2.def("sleep_for", sleep_for_fun,
- "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`", py::arg("duration"));
- m2.def("sleep_until", sleep_until_fun,
- "Block the actor sleeping until the specified timestamp, see :cpp:func:`void simgrid::s4u::this_actor::sleep_until`", py::arg("duration"));
- m2.def("suspend", &simgrid::s4u::this_actor::suspend, "Suspend the current actor, that is blocked until resume()ed by another actor. see :cpp:func:`void simgrid::s4u::this_actor::suspend`");
- m2.def("yield_", &simgrid::s4u::this_actor::yield,
- "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
- m2.def("exit", &simgrid::s4u::this_actor::exit);
+ m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.")
+ .def(
+ "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' 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::call_guard<GilScopedRelease>(),
+ "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
+ py::arg("priority") = 1)
+ .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
+ py::call_guard<GilScopedRelease>())
+ .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<GilScopedRelease>(),
+ "Moves the current actor to another host.", py::arg("dest"))
+ .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
+ py::call_guard<GilScopedRelease>(), "Block the actor sleeping for that amount of seconds.",
+ py::arg("duration"))
+ .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
+ py::call_guard<GilScopedRelease>(), "Block the actor sleeping until the specified timestamp.",
+ py::arg("duration"))
+ .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<GilScopedRelease>(),
+ "Suspend the current actor, that is blocked until resume()ed by another actor.")
+ .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<GilScopedRelease>(), "Yield the actor")
+ .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<GilScopedRelease>(), "kill the current actor")
+ .def(
+ "on_exit",
+ [](py::object fun) {
+ 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*/) {
+ GilScopedAcquire py_context; // need a new context for callback
+ try {
+ fun();
+ } catch (const py::error_already_set& e) {
+ std::string what = e.what();
+ py_context.reset();
+ xbt_die("Error while executing the on_exit lambda: %s", what.c_str());
+ }
+ });
+ },
+ py::call_guard<GilScopedRelease>(), "");
/* Class Engine */
- py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
- .def(py::init([](std::vector<std::string> args) -> simgrid::s4u::Engine* {
- static char noarg[] = {'\0'};
- int argc = args.size();
- std::unique_ptr<char* []> argv(new char*[argc + 1]);
- for (int i = 0; i != argc; ++i)
- argv[i] = args[i].empty() ? noarg : &args[i].front();
- argv[argc] = nullptr;
+ py::class_<Engine>(m, "Engine", "Simulation Engine")
+ .def(py::init([](std::vector<std::string> args) {
+ auto argc = static_cast<int>(args.size());
+ std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
+ std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
// Currently this can be dangling, we should wrap this somehow.
- return new simgrid::s4u::Engine(&argc, argv.get());
+ return new simgrid::s4u::Engine(&argc, argv.data());
}))
+ .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("get_clock", &Engine::get_clock, "Retrieve the simulation time")
- .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, "Run the simulation")
- .def("register_actor",
- [pyStopRequestEx](Engine*, std::string name, py::object fun_or_class) {
- simgrid::simix::register_function(
- name, [pyStopRequestEx, fun_or_class](std::vector<std::string> args) -> simgrid::simix::ActorCode {
- return [pyStopRequestEx, fun_or_class, args]() {
- 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 (py::error_already_set& ex) {
- if (ex.matches(pyStopRequestEx)) {
- XBT_VERB("Actor killed");
- /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
- } else {
- throw;
- }
- }
- };
- });
- },
- "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`");
+ .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("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");
/* 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>`")
+ py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulated host")
.def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
- .def("current", &Host::current, "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
- .def_property_readonly("name", [](Host* self) -> const std::string {
- return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
- }, "The name of this host")
- .def_property_readonly("speed", &Host::get_speed,
- "The peak computing speed in flops/s at the current pstate, taking the external load into account, see :cpp:func:`simgrid::s4u::Host::get_speed()`");
+ .def("get_pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
+ .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
+ .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.")
+ .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.")
+ .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.");
/* 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("by_name", &Mailbox::by_name, "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
- .def_property_readonly("name", [](Mailbox* self) -> const std::string {
- 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);
- }, "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
- .def("get", [](Mailbox self) -> py::object {
- py::object data = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(self.get())));
- data.dec_ref();
- return data;
- }, "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
+ py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "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")
+ .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")
+ .def(
+ "put",
+ [](Mailbox* self, py::object data, int size) {
+ data.inc_ref();
+ self->put(data.ptr(), size);
+ },
+ py::call_guard<GilScopedRelease>(), "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<GilScopedRelease>(), "Non-blocking data transmission")
+ .def(
+ "get",
+ [](Mailbox* self) {
+ py::object data = pybind11::reinterpret_steal<py::object>(self->get<PyObject>());
+ // data.dec_ref(); // FIXME: why does it break python-actor-create?
+ return data;
+ },
+ py::call_guard<GilScopedRelease>(), "Blocking data reception")
+ .def("set_receiver",
+ [](Mailbox* self, ActorPtr actor) {
+ self->set_receiver(actor);
+ },
+ py::call_guard<GilScopedRelease>(),
+ "Sets the actor as permanent receiver");
+
+ /* Class Comm */
+ py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm", "Communication")
+ .def("test", &simgrid::s4u::Comm::test, py::call_guard<GilScopedRelease>(),
+ "Test whether the communication is terminated.")
+ .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<GilScopedRelease>(),
+ "Block until the completion of that communication.")
+ .def("wait_all", &simgrid::s4u::Comm::wait_all, py::call_guard<GilScopedRelease>(),
+ "Block until the completion of all communications in the list.")
+ .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.");
+
+ /* Class Exec */
+ py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution")
+ .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.")
+ .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).")
+ .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.")
+ .def("test", &simgrid::s4u::Exec::test, py::call_guard<GilScopedRelease>(),
+ "Test whether the execution is terminated.")
+ .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<GilScopedRelease>(), "Cancel that execution.")
+ .def("start", &simgrid::s4u::Exec::start, py::call_guard<GilScopedRelease>(), "Start that execution.")
+ .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<GilScopedRelease>(),
+ "Block until the completion of that execution.");
/* 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",
- [pyStopRequestEx](py::str name, py::object host, py::object fun, py::args args) {
-
- return simgrid::s4u::Actor::create(name, host.cast<Host*>(), [fun, args, pyStopRequestEx]() {
-
- try {
- fun(*args);
- } catch (py::error_already_set& ex) {
- if (ex.matches(pyStopRequestEx)) {
- XBT_VERB("Actor killed");
- /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
- } else {
- throw;
- }
- }
- });
- },
- "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`")
- .def_property("host", &Actor::get_host, &Actor::migrate, "The host on which this actor is located")
- .def("daemonize", &Actor::daemonize,
- "This actor will be automatically terminated when the last non-daemon actor finishes, see :cpp:func:`void "
- "simgrid::s4u::Actor::daemonize()`")
- .def("join", py::overload_cast<double>(&Actor::join),
- "Wait for the actor to finish, see :cpp:func:`void simgrid::s4u::Actor::join(double)`", py::arg("timeout"))
- .def("migrate", &Actor::migrate,
- "Moves that actor to another host, see :cpp:func:`void simgrid::s4u::Actor::migrate()`", py::arg("dest"))
- .def("self", &Actor::self, "Retrieves the current actor, see :cpp:func:`void simgrid::s4u::Actor::self()`")
+ "application")
+ .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::const_), 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, "Suspend that actor, that is blocked until resume()ed by another actor.")
- .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed.");
+ .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.");
}
