1 /* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #warning Try to work around https://bugs.python.org/issue11566
12 #pragma GCC diagnostic push
13 #pragma GCC diagnostic ignored "-Wunused-value"
16 #include <pybind11/functional.h>
17 #include <pybind11/pybind11.h> // Must come before our own stuff
18 #include <pybind11/stl.h>
21 #pragma GCC diagnostic pop
24 #include "src/kernel/context/Context.hpp"
25 #include <simgrid/Exception.hpp>
26 #include <simgrid/s4u/Actor.hpp>
27 #include <simgrid/s4u/Comm.hpp>
28 #include <simgrid/s4u/Engine.hpp>
29 #include <simgrid/s4u/Exec.hpp>
30 #include <simgrid/s4u/Host.hpp>
31 #include <simgrid/s4u/Mailbox.hpp>
32 #include <simgrid/version.h>
38 namespace py = pybind11;
39 using simgrid::s4u::Actor;
40 using simgrid::s4u::ActorPtr;
41 using simgrid::s4u::Engine;
42 using simgrid::s4u::Host;
43 using simgrid::s4u::Mailbox;
45 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
49 static std::string get_simgrid_version()
54 sg_version_get(&major, &minor, &patch);
55 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
58 /* Classes GilScopedAcquire and GilScopedRelease have the same purpose as pybind11::gil_scoped_acquire and
59 * pybind11::gil_scoped_release. Refer to the manual of pybind11 for details:
60 * https://pybind11.readthedocs.io/en/stable/advanced/misc.html#global-interpreter-lock-gil
62 * The pybind11 versions are however too sophisticated (using TLS for example) and don't work well with all kinds of
64 * See also https://github.com/pybind/pybind11/issues/1276, which may be related.
66 * Briefly, GilScopedAcquire can be used on actor creation to acquire a new PyThreadState. The PyThreadState has to be
67 * released for context switches (i.e. before simcalls). That's the purpose of GilScopedRelease.
69 * Like their pybind11 counterparts, both classes use a RAII pattern.
71 class XBT_PRIVATE GilScopedAcquire {
72 static PyThreadState* acquire()
74 PyThreadState* state = PyThreadState_New(PyInterpreterState_Head());
75 PyEval_AcquireThread(state);
78 static void release(PyThreadState* state)
80 PyEval_ReleaseThread(state);
81 PyThreadState_Clear(state);
82 PyThreadState_Delete(state);
85 std::unique_ptr<PyThreadState, decltype(&release)> thread_state{acquire(), &release};
88 void reset() { thread_state.reset(); }
91 class XBT_PRIVATE GilScopedRelease {
92 std::unique_ptr<PyThreadState, decltype(&PyEval_RestoreThread)> thread_state{PyEval_SaveThread(),
93 &PyEval_RestoreThread};
98 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
100 PYBIND11_MODULE(simgrid, m)
102 m.doc() = "SimGrid userspace API";
104 m.attr("simgrid_version") = get_simgrid_version();
106 // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
107 static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
109 /* this_actor namespace */
110 m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.")
111 .def("info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
112 .def("error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
113 .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
114 "Block the current actor, computing the given amount of flops at the given priority, "
115 "see :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`",
116 py::arg("flops"), py::arg("priority") = 1)
117 .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init))
118 .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
119 .def("set_host", &simgrid::s4u::this_actor::set_host,
120 "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::set_host()`",
122 .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
123 "Block the actor sleeping for that amount of seconds, "
124 "see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`",
126 .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
127 "Block the actor sleeping until the specified timestamp, "
128 "see :cpp:func:`void simgrid::s4u::this_actor::sleep_until`",
130 .def("suspend", &simgrid::s4u::this_actor::suspend,
131 "Suspend the current actor, that is blocked until resume()ed by another actor. "
132 "see :cpp:func:`void simgrid::s4u::this_actor::suspend`")
133 .def("yield_", &simgrid::s4u::this_actor::yield,
134 "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`")
135 .def("exit", &simgrid::s4u::this_actor::exit, "kill the current actor")
138 simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
141 } catch (const py::error_already_set& e) {
142 xbt_die("Error while executing the on_exit lambda: %s", e.what());
149 py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
150 .def(py::init([](std::vector<std::string> args) {
151 static char noarg[] = {'\0'};
152 int argc = args.size();
153 std::unique_ptr<char* []> argv(new char*[argc + 1]);
154 for (int i = 0; i != argc; ++i)
155 argv[i] = args[i].empty() ? noarg : &args[i].front();
156 argv[argc] = nullptr;
157 // Currently this can be dangling, we should wrap this somehow.
158 return new simgrid::s4u::Engine(&argc, argv.get());
160 .def_static("get_clock", &Engine::get_clock,
161 "The simulation time, ie the amount of simulated seconds since the simulation start.")
162 .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
163 .def("load_platform", &Engine::load_platform,
164 "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
165 .def("load_deployment", &Engine::load_deployment,
166 "Load a deployment file and launch the actors that it contains, see "
167 ":cpp:func:`simgrid::s4u::Engine::load_deployment()`")
168 .def("run", &Engine::run, py::call_guard<GilScopedRelease>(), "Run the simulation")
169 .def("register_actor",
170 [](Engine* e, const std::string& name, py::object fun_or_class) {
171 e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
172 GilScopedAcquire py_context;
174 /* Convert the std::vector into a py::tuple */
175 py::tuple params(args.size() - 1);
176 for (size_t i = 1; i < args.size(); i++)
177 params[i - 1] = py::cast(args[i]);
179 py::object res = fun_or_class(*params);
181 /* If I was passed a class, I just built an instance, so I need to call it now */
182 if (py::isinstance<py::function>(res))
184 } catch (const py::error_already_set& ex) {
185 bool ffk = ex.matches(pyForcefulKillEx);
188 XBT_VERB("Actor killed");
189 /* Forward that ForcefulKill exception */
190 simgrid::ForcefulKillException::do_throw();
196 "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_actor()`");
199 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(
200 m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
201 .def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
202 .def("get_pstate_count", &Host::get_pstate_count,
203 "Retrieve the cound of defined pstate levels, see :cpp:func:`simgrid::s4u::Host::get_pstate_count`")
204 .def("get_pstate_speed", &Host::get_pstate_speed,
205 "Retrieve the maximal speed at the given pstate, see :cpp:func:`simgrid::s4u::Host::get_pstate_speed`")
206 .def_property("pstate", &Host::get_pstate, &Host::set_pstate, "The current pstate")
208 .def("current", &Host::current,
209 "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
210 .def_property_readonly("name",
211 [](const Host* self) {
212 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
214 "The name of this host")
215 .def_property_readonly(
216 "load", &Host::get_load,
217 "Returns the current computation load (in flops per second). This is the currently achieved speed. "
218 "See :cpp:func:`simgrid::s4u::Host::get_load()`")
219 .def_property_readonly(
220 "speed", &Host::get_speed,
221 "The peak computing speed in flops/s at the current pstate, taking the external load into account. "
222 "This is the max potential speed. See :cpp:func:`simgrid::s4u::Host::get_speed()`");
225 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
226 m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
227 .def("__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
228 "Textual representation of the Mailbox`")
229 .def("by_name", &Mailbox::by_name,
230 "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
231 .def_property_readonly("name",
232 [](const Mailbox* self) {
233 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
235 "The name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
237 [](Mailbox* self, py::object data, int size) {
239 self->put(data.ptr(), size);
241 "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
243 [](Mailbox* self, py::object data, int size) {
245 return self->put_async(data.ptr(), size);
247 "Non-blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put_async(void*, uint64_t)`")
250 py::object data = pybind11::reinterpret_steal<py::object>(static_cast<PyObject*>(self->get()));
254 "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
257 py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
258 "Communication, see :ref:`class s4u::Comm <API_s4u_Comm>`")
259 .def("test", &simgrid::s4u::Comm::test,
260 "Test whether the communication is terminated, see :cpp:func:`simgrid::s4u::Comm::test()`")
261 .def("wait", &simgrid::s4u::Comm::wait,
262 "Block until the completion of that communication, see :cpp:func:`simgrid::s4u::Comm::wait()`")
263 .def("wait_all", &simgrid::s4u::Comm::wait_all,
264 "Block until the completion of all communications in the list, see "
265 ":cpp:func:`simgrid::s4u::Comm::wait_all()`")
266 .def("wait_any", &simgrid::s4u::Comm::wait_any,
267 "Block until the completion of any communication in the list and return the index of the terminated one, "
268 "see :cpp:func:`simgrid::s4u::Comm::wait_any()`");
271 py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec",
272 "Execution, see :ref:`class s4u::Exec <API_s4u_Exec>`")
273 .def_property_readonly("remaining", &simgrid::s4u::Exec::get_remaining,
274 "Amount of flops that remain to be computed until completion, see "
275 ":cpp:func:`simgrid::s4u::Exec::get_remaining()`")
276 .def_property_readonly("remaining_ratio", &simgrid::s4u::Exec::get_remaining_ratio,
277 "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
278 "yet). See :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio()`")
279 .def_property("host",
280 [](simgrid::s4u::ExecPtr self) {
281 simgrid::s4u::ExecSeqPtr seq = boost::dynamic_pointer_cast<simgrid::s4u::ExecSeq>(self);
283 return seq->get_host();
284 xbt_throw_unimplemented(__FILE__, __LINE__,
285 "host of parallel executions is not implemented in python yet.");
287 &simgrid::s4u::Exec::set_host,
288 "Host on which this execution runs. See :cpp:func:`simgrid::s4u::ExecSeq::get_host()`")
289 .def("test", &simgrid::s4u::Exec::test,
290 "Test whether the execution is terminated, see :cpp:func:`simgrid::s4u::Exec::test()`")
291 .def("cancel", &simgrid::s4u::Exec::cancel, "Cancel that execution, see :cpp:func:`simgrid::s4u::Exec::cancel()`")
292 .def("start", &simgrid::s4u::Exec::start, "Start that execution, see :cpp:func:`simgrid::s4u::Exec::start()`")
293 .def("wait", &simgrid::s4u::Exec::wait,
294 "Block until the completion of that execution, see :cpp:func:`simgrid::s4u::Exec::wait()`");
297 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
298 "An actor is an independent stream of execution in your distributed "
299 "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
301 [](py::str name, Host* host, py::object fun, py::args args) {
302 return simgrid::s4u::Actor::create(name, host, [fun, args]() {
303 GilScopedAcquire py_context;
306 } catch (const py::error_already_set& ex) {
307 bool ffk = ex.matches(pyForcefulKillEx);
310 XBT_VERB("Actor killed");
311 /* Forward that ForcefulKill exception */
312 simgrid::ForcefulKillException::do_throw();
318 py::call_guard<GilScopedRelease>(), "Create an actor from a function or an object.")
319 .def_property("host", &Actor::get_host, &Actor::set_host, "The host on which this actor is located")
320 .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
321 .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
322 .def_property_readonly("ppid", &Actor::get_ppid,
323 "The PID (unique identifier) of the actor that created this one.")
324 .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
325 .def("daemonize", &Actor::daemonize,
326 "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
328 .def("is_daemon", &Actor::is_daemon,
329 "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
331 .def("join", py::overload_cast<double>(&Actor::join),
332 "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
333 .def("kill", &Actor::kill, "Kill that actor")
334 .def("kill_all", &Actor::kill_all, "Kill all actors but the caller.")
335 .def("self", &Actor::self, "Retrieves the current actor.")
336 .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
337 .def("suspend", &Actor::suspend, "Suspend that actor, that is blocked until resume()ed by another actor.")
338 .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed.");