Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
please sonar
[simgrid.git] / src / bindings / python / simgrid_python.cpp
1 /* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifdef _WIN32
7 #warning Try to work around https://bugs.python.org/issue11566
8 #define _hypot hypot
9 #endif
10
11 #if defined(__GNUG__)
12 #pragma GCC diagnostic push
13 #pragma GCC diagnostic ignored "-Wunused-value"
14 #endif
15
16 #include <pybind11/functional.h>
17 #include <pybind11/pybind11.h> // Must come before our own stuff
18 #include <pybind11/stl.h>
19
20 #if defined(__GNUG__)
21 #pragma GCC diagnostic pop
22 #endif
23
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>
33
34 #include <memory>
35 #include <string>
36 #include <vector>
37
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;
44
45 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
46
47 namespace {
48
49 static std::string get_simgrid_version()
50 {
51   int major;
52   int minor;
53   int patch;
54   sg_version_get(&major, &minor, &patch);
55   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
56 }
57
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
61  *
62  * The pybind11 versions are however too sophisticated (using TLS for example) and don't work well with all kinds of
63  * contexts.
64  * See also https://github.com/pybind/pybind11/issues/1276, which may be related.
65  *
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.
68  *
69  * Like their pybind11 counterparts, both classes use a RAII pattern.
70  */
71 class XBT_PRIVATE GilScopedAcquire {
72   static PyThreadState* acquire()
73   {
74     PyThreadState* state = PyThreadState_New(PyInterpreterState_Head());
75     PyEval_AcquireThread(state);
76     return state;
77   }
78   static void release(PyThreadState* state)
79   {
80     PyEval_ReleaseThread(state);
81     PyThreadState_Clear(state);
82     PyThreadState_Delete(state);
83   }
84
85   std::unique_ptr<PyThreadState, decltype(&release)> thread_state{acquire(), &release};
86
87 public:
88   void reset() { thread_state.reset(); }
89 };
90
91 class XBT_PRIVATE GilScopedRelease {
92   std::unique_ptr<PyThreadState, decltype(&PyEval_RestoreThread)> thread_state{PyEval_SaveThread(),
93                                                                                &PyEval_RestoreThread};
94 };
95
96 } // namespace
97
98 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
99
100 PYBIND11_MODULE(simgrid, m)
101 {
102   m.doc() = "SimGrid userspace API";
103
104   m.attr("simgrid_version") = get_simgrid_version();
105
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"));
108
109   /* this_actor namespace */
110   m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.")
111       .def(
112           "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
113       .def(
114           "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
115       .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
116            py::call_guard<GilScopedRelease>(),
117            "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
118            py::arg("priority") = 1)
119       .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
120            py::call_guard<GilScopedRelease>())
121       .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
122       .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<GilScopedRelease>(),
123            "Moves the current actor to another host.", py::arg("dest"))
124       .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
125            py::call_guard<GilScopedRelease>(), "Block the actor sleeping for that amount of seconds.",
126            py::arg("duration"))
127       .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
128            py::call_guard<GilScopedRelease>(), "Block the actor sleeping until the specified timestamp.",
129            py::arg("duration"))
130       .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<GilScopedRelease>(),
131            "Suspend the current actor, that is blocked until resume()ed by another actor.")
132       .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<GilScopedRelease>(), "Yield the actor")
133       .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<GilScopedRelease>(), "kill the current actor")
134       .def(
135           "on_exit",
136           [](py::object fun) {
137             fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
138             simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
139               GilScopedAcquire py_context; // need a new context for callback
140               try {
141                 fun();
142               } catch (const py::error_already_set& e) {
143                 std::string what = e.what();
144                 py_context.reset();
145                 xbt_die("Error while executing the on_exit lambda: %s", what.c_str());
146               }
147             });
148           },
149           py::call_guard<GilScopedRelease>(), "");
150
151   /* Class Engine */
152   py::class_<Engine>(m, "Engine", "Simulation Engine")
153       .def(py::init([](std::vector<std::string> args) {
154         static char noarg[] = {'\0'};
155         int argc            = args.size();
156         std::unique_ptr<char* []> argv(new char*[argc + 1]);
157         for (int i = 0; i != argc; ++i)
158           argv[i] = args[i].empty() ? noarg : &args[i].front();
159         argv[argc] = nullptr;
160         // Currently this can be dangling, we should wrap this somehow.
161         return new simgrid::s4u::Engine(&argc, argv.get());
162       }))
163       .def_static("get_clock", &Engine::get_clock,
164                   "The simulation time, ie the amount of simulated seconds since the simulation start.")
165       .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
166       .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
167       .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
168       .def("run", &Engine::run, py::call_guard<GilScopedRelease>(), "Run the simulation")
169       .def(
170           "register_actor",
171           [](Engine* e, const std::string& name, py::object fun_or_class) {
172             e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
173               GilScopedAcquire py_context;
174               try {
175                 /* Convert the std::vector into a py::tuple */
176                 py::tuple params(args.size() - 1);
177                 for (size_t i = 1; i < args.size(); i++)
178                   params[i - 1] = py::cast(args[i]);
179
180                 py::object res = fun_or_class(*params);
181
182                 /* If I was passed a class, I just built an instance, so I need to call it now */
183                 if (py::isinstance<py::function>(res))
184                   res();
185               } catch (const py::error_already_set& ex) {
186                 bool ffk = ex.matches(pyForcefulKillEx);
187                 py_context.reset();
188                 if (ffk) {
189                   XBT_VERB("Actor killed");
190                   /* Forward that ForcefulKill exception */
191                   simgrid::ForcefulKillException::do_throw();
192                 }
193                 throw;
194               }
195             });
196           },
197           "Registers the main function of an actor");
198
199   /* Class Host */
200   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulated 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, "Retrieve the cound of defined pstate levels")
203       .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
204       .def_property(
205           "pstate", &Host::get_pstate,
206           [](Host* h, int i) {
207             GilScopedRelease gil_guard;
208             h->set_pstate(i);
209           },
210           "The current pstate")
211       .def("current", &Host::current, py::call_guard<GilScopedRelease>(),
212            "Retrieves the host on which the running actor is located.")
213       .def_property_readonly(
214           "name",
215           [](const Host* self) {
216             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
217           },
218           "The name of this host")
219       .def_property_readonly(
220           "load", &Host::get_load,
221           "Returns the current computation load (in flops per second). This is the currently achieved speed.")
222       .def_property_readonly(
223           "speed", &Host::get_speed,
224           "The peak computing speed in flops/s at the current pstate, taking the external load into account. "
225           "This is the max potential speed.");
226
227   /* Class Mailbox */
228   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox")
229       .def(
230           "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
231           "Textual representation of the Mailbox`")
232       .def("by_name", &Mailbox::by_name, py::call_guard<GilScopedRelease>(), "Retrieve a Mailbox from its name")
233       .def_property_readonly(
234           "name",
235           [](const Mailbox* self) {
236             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
237           },
238           "The name of that mailbox")
239       .def(
240           "put",
241           [](Mailbox* self, py::object data, int size) {
242             data.inc_ref();
243             self->put(data.ptr(), size);
244           },
245           py::call_guard<GilScopedRelease>(), "Blocking data transmission")
246       .def(
247           "put_async",
248           [](Mailbox* self, py::object data, int size) {
249             data.inc_ref();
250             return self->put_async(data.ptr(), size);
251           },
252           py::call_guard<GilScopedRelease>(), "Non-blocking data transmission")
253       .def(
254           "get",
255           [](Mailbox* self) {
256             py::object data = pybind11::reinterpret_steal<py::object>(static_cast<PyObject*>(self->get()));
257             // data.dec_ref(); // FIXME: why does it break python-actor-create?
258             return data;
259           },
260           py::call_guard<GilScopedRelease>(), "Blocking data reception")
261       .def("set_receiver",
262          [](Mailbox* self, ActorPtr actor) {
263            self->set_receiver(actor);
264          },
265          py::call_guard<GilScopedRelease>(),
266          "Sets the actor as permanent receiver");
267
268   /* Class Comm */
269   py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm", "Communication")
270       .def("test", &simgrid::s4u::Comm::test, py::call_guard<GilScopedRelease>(),
271            "Test whether the communication is terminated.")
272       .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<GilScopedRelease>(),
273            "Block until the completion of that communication.")
274       .def("wait_all", &simgrid::s4u::Comm::wait_all, py::call_guard<GilScopedRelease>(),
275            "Block until the completion of all communications in the list.")
276       .def("wait_any", &simgrid::s4u::Comm::wait_any, py::call_guard<GilScopedRelease>(),
277            "Block until the completion of any communication in the list and return the index of the terminated one.");
278
279   /* Class Exec */
280   py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution")
281       .def_property_readonly(
282           "remaining",
283           [](simgrid::s4u::ExecPtr self) {
284             GilScopedRelease gil_guard;
285             return self->get_remaining();
286           },
287           "Amount of flops that remain to be computed until completion.")
288       .def_property_readonly(
289           "remaining_ratio",
290           [](simgrid::s4u::ExecPtr self) {
291             GilScopedRelease gil_guard;
292             return self->get_remaining_ratio();
293           },
294           "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
295           "yet).")
296       .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
297                     "Host on which this execution runs. Only the first host is returned for parallel executions.")
298       .def("test", &simgrid::s4u::Exec::test, py::call_guard<GilScopedRelease>(),
299            "Test whether the execution is terminated.")
300       .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<GilScopedRelease>(), "Cancel that execution.")
301       .def("start", &simgrid::s4u::Exec::start, py::call_guard<GilScopedRelease>(), "Start that execution.")
302       .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<GilScopedRelease>(),
303            "Block until the completion of that execution.");
304
305   /* Class Actor */
306   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
307                                             "An actor is an independent stream of execution in your distributed "
308                                             "application")
309       .def(
310           "create",
311           [](py::str name, Host* host, py::object fun, py::args args) {
312             fun.inc_ref();  // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
313             args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
314             return simgrid::s4u::Actor::create(name, host, [fun, args]() {
315               GilScopedAcquire py_context;
316               try {
317                 fun(*args);
318               } catch (const py::error_already_set& ex) {
319                 bool ffk = ex.matches(pyForcefulKillEx);
320                 py_context.reset();
321                 if (ffk) {
322                   XBT_VERB("Actor killed");
323                   /* Forward that ForcefulKill exception */
324                   simgrid::ForcefulKillException::do_throw();
325                 }
326                 throw;
327               }
328             });
329           },
330           py::call_guard<GilScopedRelease>(), "Create an actor from a function or an object.")
331       .def_property(
332           "host", &Actor::get_host,
333           [](Actor* a, Host* h) {
334             GilScopedRelease gil_guard;
335             a->set_host(h);
336           },
337           "The host on which this actor is located")
338       .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
339       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
340       .def_property_readonly("ppid", &Actor::get_ppid,
341                              "The PID (unique identifier) of the actor that created this one.")
342       .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
343       .def("daemonize", &Actor::daemonize, py::call_guard<GilScopedRelease>(),
344            "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
345            "documentation).")
346       .def("is_daemon", &Actor::is_daemon,
347            "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
348            "terminates.")
349       .def("join", py::overload_cast<double>(&Actor::join), py::call_guard<GilScopedRelease>(),
350            "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
351       .def("kill", &Actor::kill, py::call_guard<GilScopedRelease>(), "Kill that actor")
352       .def("kill_all", &Actor::kill_all, py::call_guard<GilScopedRelease>(), "Kill all actors but the caller.")
353       .def("self", &Actor::self, "Retrieves the current actor.")
354       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
355       .def("suspend", &Actor::suspend, py::call_guard<GilScopedRelease>(),
356            "Suspend that actor, that is blocked until resume()ed by another actor.")
357       .def("resume", &Actor::resume, py::call_guard<GilScopedRelease>(),
358            "Resume that actor, that was previously suspend()ed.");
359 }