1 /* Copyright (c) 2018-2021. 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"
17 /* Many tests are failing after pybind11 commit ad6bf5cd39ca64b4a9bf846b84b11c4c8df1c8e1 "Adding PyGILState_Check() in
18 * object_api<>::operator(). (#2919)".
19 * See https://github.com/pybind/pybind11/commit/ad6bf5cd39ca64b4a9bf846b84b11c4c8df1c8e1
21 * The failing tests are mostly those with boost/raw/sysv contexts. As a workaround, define NDEBUG before pybind11
25 #define NDEBUG_LOCALLY_DEFINED
28 #include <pybind11/pybind11.h> // Must come before our own stuff
30 #include <pybind11/functional.h>
31 #include <pybind11/stl.h>
33 #ifdef NDEBUG_LOCALLY_DEFINED
34 #undef NDEBUG_LOCALLY_DEFINED
39 #pragma GCC diagnostic pop
42 #include "simgrid/kernel/routing/NetPoint.hpp"
43 #include "src/kernel/context/Context.hpp"
44 #include <simgrid/Exception.hpp>
45 #include <simgrid/s4u/Actor.hpp>
46 #include <simgrid/s4u/Comm.hpp>
47 #include <simgrid/s4u/Engine.hpp>
48 #include <simgrid/s4u/Exec.hpp>
49 #include <simgrid/s4u/Host.hpp>
50 #include <simgrid/s4u/Link.hpp>
51 #include <simgrid/s4u/Mailbox.hpp>
52 #include <simgrid/s4u/NetZone.hpp>
53 #include <simgrid/version.h>
60 namespace py = pybind11;
61 using simgrid::s4u::Actor;
62 using simgrid::s4u::ActorPtr;
63 using simgrid::s4u::Engine;
64 using simgrid::s4u::Host;
65 using simgrid::s4u::Mailbox;
67 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
71 std::string get_simgrid_version()
76 sg_version_get(&major, &minor, &patch);
77 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
80 /** @brief Wrap for mailbox::get_async */
82 std::unique_ptr<PyObject*> data = std::make_unique<PyObject*>();
85 PyObject** get() const { return data.get(); }
88 /* Classes GilScopedAcquire and GilScopedRelease have the same purpose as pybind11::gil_scoped_acquire and
89 * pybind11::gil_scoped_release. Refer to the manual of pybind11 for details:
90 * https://pybind11.readthedocs.io/en/stable/advanced/misc.html#global-interpreter-lock-gil
92 * The pybind11 versions are however too sophisticated (using TLS for example) and don't work well with all kinds of
94 * See also https://github.com/pybind/pybind11/issues/1276, which may be related.
96 * Briefly, GilScopedAcquire can be used on actor creation to acquire a new PyThreadState. The PyThreadState has to be
97 * released for context switches (i.e. before simcalls). That's the purpose of GilScopedRelease.
99 * Like their pybind11 counterparts, both classes use a RAII pattern.
101 class XBT_PRIVATE GilScopedAcquire {
102 static PyThreadState* acquire()
104 PyThreadState* state = PyThreadState_New(PyInterpreterState_Head());
105 PyEval_AcquireThread(state);
108 static void release(PyThreadState* state)
110 PyEval_ReleaseThread(state);
111 PyThreadState_Clear(state);
112 PyThreadState_Delete(state);
115 std::unique_ptr<PyThreadState, decltype(&release)> thread_state{acquire(), &release};
118 void reset() { thread_state.reset(); }
121 class XBT_PRIVATE GilScopedRelease {
122 std::unique_ptr<PyThreadState, decltype(&PyEval_RestoreThread)> thread_state{PyEval_SaveThread(),
123 &PyEval_RestoreThread};
128 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
130 PYBIND11_MODULE(simgrid, m)
132 m.doc() = "SimGrid userspace API";
134 m.attr("simgrid_version") = get_simgrid_version();
136 // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
137 static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
139 /* this_actor namespace */
140 m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.")
142 "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
144 "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
145 .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
146 py::call_guard<GilScopedRelease>(),
147 "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
148 py::arg("priority") = 1)
149 .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
150 py::call_guard<GilScopedRelease>())
151 .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
152 .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<GilScopedRelease>(),
153 "Moves the current actor to another host.", py::arg("dest"))
154 .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
155 py::call_guard<GilScopedRelease>(), "Block the actor sleeping for that amount of seconds.",
157 .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
158 py::call_guard<GilScopedRelease>(), "Block the actor sleeping until the specified timestamp.",
160 .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<GilScopedRelease>(),
161 "Suspend the current actor, that is blocked until resume()ed by another actor.")
162 .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<GilScopedRelease>(), "Yield the actor")
163 .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<GilScopedRelease>(), "kill the current actor")
167 fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
168 simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
169 GilScopedAcquire py_context; // need a new context for callback
172 } catch (const py::error_already_set& e) {
173 std::string what = e.what();
175 xbt_die("Error while executing the on_exit lambda: %s", what.c_str());
179 py::call_guard<GilScopedRelease>(), "");
182 py::class_<Engine>(m, "Engine", "Simulation Engine")
183 .def(py::init([](std::vector<std::string> args) {
184 auto argc = static_cast<int>(args.size());
185 std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
186 std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
187 // Currently this can be dangling, we should wrap this somehow.
188 return new simgrid::s4u::Engine(&argc, argv.data());
190 .def_static("get_clock", &Engine::get_clock,
191 "The simulation time, ie the amount of simulated seconds since the simulation start.")
192 .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
193 .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
194 .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
195 .def("run", &Engine::run, py::call_guard<GilScopedRelease>(), "Run the simulation")
198 [](Engine* e, const std::string& name, py::object fun_or_class) {
199 e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
200 GilScopedAcquire py_context;
202 /* Convert the std::vector into a py::tuple */
203 py::tuple params(args.size() - 1);
204 for (size_t i = 1; i < args.size(); i++)
205 params[i - 1] = py::cast(args[i]);
207 py::object res = fun_or_class(*params);
208 /* If I was passed a class, I just built an instance, so I need to call it now */
209 if (py::isinstance<py::function>(res))
211 } catch (const py::error_already_set& ex) {
212 bool ffk = ex.matches(pyForcefulKillEx);
215 XBT_VERB("Actor killed");
216 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
222 "Registers the main function of an actor");
225 py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>>(m, "NetZone",
227 .def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
228 .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
229 .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
230 .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
231 .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
233 py::overload_cast<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
234 simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
235 const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
236 "Add a route between 2 netpoints")
237 .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
240 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
243 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
244 "Creates a network link")
245 .def("create_split_duplex_link",
246 py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
247 "Creates a split-duplex link")
248 .def("create_split_duplex_link",
249 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
250 "Creates a split-duplex link")
251 .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
252 .def("get_netpoint", &simgrid::s4u::NetZone::get_netpoint, "Retrieve the netpoint associated to this zone")
253 .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone");
255 /* Class ClusterCallbacks */
256 py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
257 .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
258 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
259 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
261 /* Class FatTreeParams */
262 py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
263 .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
264 const std::vector<unsigned int>&>());
266 /* Class DragonflyParams */
267 py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
268 .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
269 const std::pair<unsigned int, unsigned int>&, unsigned int>());
272 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulated host")
273 .def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
274 .def("get_pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
275 .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
276 .def("get_netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this host")
277 .def("seal", &Host::seal, "Seal this host")
279 "pstate", &Host::get_pstate,
281 GilScopedRelease gil_guard;
284 "The current pstate")
285 .def("current", &Host::current, py::call_guard<GilScopedRelease>(),
286 "Retrieves the host on which the running actor is located.")
287 .def_property_readonly(
289 [](const Host* self) {
290 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
292 "The name of this host")
293 .def_property_readonly(
294 "load", &Host::get_load,
295 "Returns the current computation load (in flops per second). This is the currently achieved speed.")
296 .def_property_readonly(
297 "speed", &Host::get_speed,
298 "The peak computing speed in flops/s at the current pstate, taking the external load into account. "
299 "This is the max potential speed.");
302 py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>(
303 m, "NetPoint", "NetPoint object");
306 py::class_<simgrid::s4u::Link, std::unique_ptr<simgrid::s4u::Link, py::nodelete>> link(m, "Link", "Network link");
307 link.def("set_latency", py::overload_cast<const std::string&>(&simgrid::s4u::Link::set_latency), "Set the latency");
308 link.def("set_latency", py::overload_cast<double>(&simgrid::s4u::Link::set_latency), "Set the latency");
309 link.def("set_sharing_policy", &simgrid::s4u::Link::set_sharing_policy, "Set sharing policy for this link");
310 link.def("seal", &simgrid::s4u::Link::seal, "Seal this link");
311 link.def_property_readonly(
313 [](const simgrid::s4u::Link* self) {
314 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
316 "The name of this link");
317 py::enum_<simgrid::s4u::Link::SharingPolicy>(link, "SharingPolicy")
318 .value("NONLINEAR", simgrid::s4u::Link::SharingPolicy::NONLINEAR)
319 .value("WIFI", simgrid::s4u::Link::SharingPolicy::WIFI)
320 .value("SPLITDUPLEX", simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX)
321 .value("SHARED", simgrid::s4u::Link::SharingPolicy::SHARED)
322 .value("FATPIPE", simgrid::s4u::Link::SharingPolicy::FATPIPE)
325 /* Class LinkInRoute */
326 py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
327 linkinroute.def(py::init<const simgrid::s4u::Link*>());
328 linkinroute.def(py::init<const simgrid::s4u::Link*, simgrid::s4u::LinkInRoute::Direction>());
329 py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
330 .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
331 .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
332 .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE)
335 /* Class Split-Duplex Link */
336 py::class_<simgrid::s4u::SplitDuplexLink, simgrid::s4u::Link,
337 std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(m, "SplitDuplexLink",
338 "Network split-duplex link")
339 .def("get_link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
340 .def("get_link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
343 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox")
345 "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
346 "Textual representation of the Mailbox`")
347 .def("by_name", &Mailbox::by_name, py::call_guard<GilScopedRelease>(), "Retrieve a Mailbox from its name")
348 .def_property_readonly(
350 [](const Mailbox* self) {
351 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
353 "The name of that mailbox")
356 [](Mailbox* self, py::object data, int size) {
358 self->put(data.ptr(), size);
360 py::call_guard<GilScopedRelease>(), "Blocking data transmission")
363 [](Mailbox* self, py::object data, int size) {
365 return self->put_async(data.ptr(), size);
367 py::call_guard<GilScopedRelease>(), "Non-blocking data transmission")
371 py::object data = pybind11::reinterpret_steal<py::object>(self->get<PyObject>());
372 // data.dec_ref(); // FIXME: why does it break python-actor-create?
375 py::call_guard<GilScopedRelease>(), "Blocking data reception")
378 [](Mailbox* self) -> std::tuple<simgrid::s4u::CommPtr, PyGetAsync> {
380 auto comm = self->get_async(wrap.get());
381 return std::make_tuple(std::move(comm), std::move(wrap));
383 py::call_guard<GilScopedRelease>(),
384 "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
386 "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); },
387 py::call_guard<GilScopedRelease>(), "Sets the actor as permanent receiver");
389 /* Class PyGetAsync */
390 py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
393 "get", [](PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
394 "Get python object after async communication in receiver side");
397 py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm", "Communication")
398 .def("test", &simgrid::s4u::Comm::test, py::call_guard<GilScopedRelease>(),
399 "Test whether the communication is terminated.")
400 .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<GilScopedRelease>(),
401 "Block until the completion of that communication.")
402 // use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
403 .def_static("wait_all",
404 py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
405 py::call_guard<GilScopedRelease>(), "Block until the completion of all communications in the list.")
407 "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
408 py::call_guard<GilScopedRelease>(),
409 "Block until the completion of any communication in the list and return the index of the terminated one.");
412 py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution")
413 .def_property_readonly(
415 [](simgrid::s4u::ExecPtr self) {
416 GilScopedRelease gil_guard;
417 return self->get_remaining();
419 "Amount of flops that remain to be computed until completion.")
420 .def_property_readonly(
422 [](simgrid::s4u::ExecPtr self) {
423 GilScopedRelease gil_guard;
424 return self->get_remaining_ratio();
426 "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
428 .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
429 "Host on which this execution runs. Only the first host is returned for parallel executions.")
430 .def("test", &simgrid::s4u::Exec::test, py::call_guard<GilScopedRelease>(),
431 "Test whether the execution is terminated.")
432 .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<GilScopedRelease>(), "Cancel that execution.")
433 .def("start", &simgrid::s4u::Exec::start, py::call_guard<GilScopedRelease>(), "Start that execution.")
434 .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<GilScopedRelease>(),
435 "Block until the completion of that execution.");
438 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
439 "An actor is an independent stream of execution in your distributed "
443 [](py::str name, Host* host, py::object fun, py::args args) {
444 fun.inc_ref(); // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
445 args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
446 return simgrid::s4u::Actor::create(name, host, [fun, args]() {
447 GilScopedAcquire py_context;
450 } catch (const py::error_already_set& ex) {
451 bool ffk = ex.matches(pyForcefulKillEx);
454 XBT_VERB("Actor killed");
455 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
461 py::call_guard<GilScopedRelease>(), "Create an actor from a function or an object.")
463 "host", &Actor::get_host,
464 [](Actor* a, Host* h) {
465 GilScopedRelease gil_guard;
468 "The host on which this actor is located")
469 .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
470 .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
471 .def_property_readonly("ppid", &Actor::get_ppid,
472 "The PID (unique identifier) of the actor that created this one.")
473 .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
474 .def("daemonize", &Actor::daemonize, py::call_guard<GilScopedRelease>(),
475 "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
477 .def("is_daemon", &Actor::is_daemon,
478 "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
480 .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<GilScopedRelease>(),
481 "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
482 .def("kill", &Actor::kill, py::call_guard<GilScopedRelease>(), "Kill that actor")
483 .def("kill_all", &Actor::kill_all, py::call_guard<GilScopedRelease>(), "Kill all actors but the caller.")
484 .def("self", &Actor::self, "Retrieves the current actor.")
485 .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
486 .def("suspend", &Actor::suspend, py::call_guard<GilScopedRelease>(),
487 "Suspend that actor, that is blocked until resume()ed by another actor.")
488 .def("resume", &Actor::resume, py::call_guard<GilScopedRelease>(),
489 "Resume that actor, that was previously suspend()ed.");