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/Disk.hpp>
48 #include <simgrid/s4u/Engine.hpp>
49 #include <simgrid/s4u/Exec.hpp>
50 #include <simgrid/s4u/Host.hpp>
51 #include <simgrid/s4u/Link.hpp>
52 #include <simgrid/s4u/Mailbox.hpp>
53 #include <simgrid/s4u/NetZone.hpp>
54 #include <simgrid/version.h>
61 namespace py = pybind11;
62 using simgrid::s4u::Actor;
63 using simgrid::s4u::ActorPtr;
64 using simgrid::s4u::Engine;
65 using simgrid::s4u::Host;
66 using simgrid::s4u::Mailbox;
68 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
72 std::string get_simgrid_version()
77 sg_version_get(&major, &minor, &patch);
78 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
81 /** @brief Wrap for mailbox::get_async */
83 std::unique_ptr<PyObject*> data = std::make_unique<PyObject*>();
86 PyObject** get() const { return data.get(); }
89 /* Classes GilScopedAcquire and GilScopedRelease have the same purpose as pybind11::gil_scoped_acquire and
90 * pybind11::gil_scoped_release. Refer to the manual of pybind11 for details:
91 * https://pybind11.readthedocs.io/en/stable/advanced/misc.html#global-interpreter-lock-gil
93 * The pybind11 versions are however too sophisticated (using TLS for example) and don't work well with all kinds of
95 * See also https://github.com/pybind/pybind11/issues/1276, which may be related.
97 * Briefly, GilScopedAcquire can be used on actor creation to acquire a new PyThreadState. The PyThreadState has to be
98 * released for context switches (i.e. before simcalls). That's the purpose of GilScopedRelease.
100 * Like their pybind11 counterparts, both classes use a RAII pattern.
102 class XBT_PRIVATE GilScopedAcquire {
103 static PyThreadState* acquire()
105 PyThreadState* state = PyThreadState_New(PyInterpreterState_Head());
106 PyEval_AcquireThread(state);
109 static void release(PyThreadState* state)
111 PyEval_ReleaseThread(state);
112 PyThreadState_Clear(state);
113 PyThreadState_Delete(state);
116 std::unique_ptr<PyThreadState, decltype(&release)> thread_state{acquire(), &release};
119 class XBT_PRIVATE GilScopedRelease {
120 std::unique_ptr<PyThreadState, decltype(&PyEval_RestoreThread)> thread_state{PyEval_SaveThread(),
121 &PyEval_RestoreThread};
126 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
128 PYBIND11_MODULE(simgrid, m)
130 m.doc() = "SimGrid userspace API";
132 m.attr("simgrid_version") = get_simgrid_version();
134 // Swapped contexts are broken, starting from pybind11 v2.8.0. Use thread contexts by default.
135 simgrid::s4u::Engine::set_config("contexts/factory:thread");
137 // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
138 static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
140 /* this_actor namespace */
141 m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.")
143 "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
145 "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
146 .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
147 py::call_guard<GilScopedRelease>(),
148 "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
149 py::arg("priority") = 1)
150 .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
151 py::call_guard<GilScopedRelease>())
152 .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
153 .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<GilScopedRelease>(),
154 "Moves the current actor to another host.", py::arg("dest"))
155 .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
156 py::call_guard<GilScopedRelease>(), "Block the actor sleeping for that amount of seconds.",
158 .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
159 py::call_guard<GilScopedRelease>(), "Block the actor sleeping until the specified timestamp.",
161 .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<GilScopedRelease>(),
162 "Suspend the current actor, that is blocked until resume()ed by another actor.")
163 .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<GilScopedRelease>(), "Yield the actor")
164 .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<GilScopedRelease>(), "kill the current actor")
168 fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
169 simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
171 GilScopedAcquire py_context; // need a new context for callback
173 } catch (const py::error_already_set& e) {
174 xbt_die("Error while executing the on_exit lambda: %s", e.what());
178 py::call_guard<GilScopedRelease>(), "");
181 py::class_<Engine>(m, "Engine", "Simulation Engine")
182 .def(py::init([](std::vector<std::string> args) {
183 auto argc = static_cast<int>(args.size());
184 std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
185 std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
186 // Currently this can be dangling, we should wrap this somehow.
187 return new simgrid::s4u::Engine(&argc, argv.data());
189 .def_static("get_clock", &Engine::get_clock,
190 "The simulation time, ie the amount of simulated seconds since the simulation start.")
191 .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
192 .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
193 .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
194 .def("run", &Engine::run, py::call_guard<GilScopedRelease>(), "Run the simulation")
197 [](Engine* e, const std::string& name, py::object fun_or_class) {
198 e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
200 GilScopedAcquire py_context;
201 /* Convert the std::vector into a py::tuple */
202 py::tuple params(args.size() - 1);
203 for (size_t i = 1; i < args.size(); i++)
204 params[i - 1] = py::cast(args[i]);
206 py::object res = fun_or_class(*params);
207 /* If I was passed a class, I just built an instance, so I need to call it now */
208 if (py::isinstance<py::function>(res))
210 } catch (const py::error_already_set& ex) {
211 if (ex.matches(pyForcefulKillEx)) {
212 XBT_VERB("Actor killed");
213 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
219 "Registers the main function of an actor");
222 py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>> netzone(m, "NetZone",
224 netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
225 .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
226 .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
227 .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
228 .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
229 .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd")
230 .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra")
231 .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi")
232 .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty")
233 .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi")
235 py::overload_cast<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
236 simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
237 const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
238 "Add a route between 2 netpoints")
239 .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
242 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
245 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
248 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
250 .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
251 "Creates a network link")
253 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
254 "Creates a network link")
256 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
257 "Creates a network link")
259 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
260 "Creates a network link")
261 .def("create_split_duplex_link",
262 py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
263 "Creates a split-duplex link")
264 .def("create_split_duplex_link",
265 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
266 "Creates a split-duplex link")
267 .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
268 .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
269 .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
270 .def("get_netpoint", &simgrid::s4u::NetZone::get_netpoint, "Retrieve the netpoint associated to this zone")
271 .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
272 .def_property_readonly(
273 "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); }, "The name of this network zone");
275 /* Class ClusterCallbacks */
276 py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
277 .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
278 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
279 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
281 /* Class FatTreeParams */
282 py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
283 .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
284 const std::vector<unsigned int>&>());
286 /* Class DragonflyParams */
287 py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
288 .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
289 const std::pair<unsigned int, unsigned int>&, unsigned int>());
292 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(m, "Host", "Simulated host");
293 host.def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
294 .def("get_pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
295 .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
296 .def("get_netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this host")
297 .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
298 .def("set_core_count", &Host::set_core_count, "Set the number of cores in the CPU")
299 .def("set_coordinates", &Host::set_coordinates, "Set the coordinates of this host")
300 .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, "Describe how the CPU is shared",
301 py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
302 .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk), "Create a disk")
304 py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
306 .def("seal", &Host::seal, "Seal this host")
308 "pstate", &Host::get_pstate,
310 GilScopedRelease gil_guard;
313 "The current pstate")
314 .def("current", &Host::current, py::call_guard<GilScopedRelease>(),
315 "Retrieves the host on which the running actor is located.")
316 .def_property_readonly(
318 [](const Host* self) {
319 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
321 "The name of this host")
322 .def_property_readonly(
323 "load", &Host::get_load,
324 "Returns the current computation load (in flops per second). This is the currently achieved speed.")
325 .def_property_readonly(
326 "speed", &Host::get_speed,
327 "The peak computing speed in flops/s at the current pstate, taking the external load into account. "
328 "This is the max potential speed.");
329 py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
330 .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
331 .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR)
335 py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(m, "Disk", "Simulated disk");
336 disk.def("read", &simgrid::s4u::Disk::read, py::call_guard<GilScopedRelease>(), "Read data from disk")
337 .def("write", &simgrid::s4u::Disk::write, py::call_guard<GilScopedRelease>(), "Write data in disk")
338 .def("read_async", &simgrid::s4u::Disk::read_async, "Non-blocking read data from disk")
339 .def("write_async", &simgrid::s4u::Disk::write_async, "Non-blocking write data in disk")
340 .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, "Set sharing policy for this disk",
341 py::arg("op"), py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
342 .def("seal", &simgrid::s4u::Disk::seal, "Seal this disk")
343 .def_property_readonly(
344 "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); }, "The name of this disk");
345 py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
346 .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
347 .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR)
349 py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
350 .value("READ", simgrid::s4u::Disk::Operation::READ)
351 .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
352 .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE)
356 py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
357 netpoint(m, "NetPoint", "NetPoint object");
360 py::class_<simgrid::s4u::Link, std::unique_ptr<simgrid::s4u::Link, py::nodelete>> link(m, "Link", "Network link");
361 link.def("set_latency", py::overload_cast<const std::string&>(&simgrid::s4u::Link::set_latency), "Set the latency")
362 .def("set_latency", py::overload_cast<double>(&simgrid::s4u::Link::set_latency), "Set the latency")
363 .def("set_sharing_policy", &simgrid::s4u::Link::set_sharing_policy, "Set sharing policy for this link")
364 .def("set_concurrency_limit", &simgrid::s4u::Link::set_concurrency_limit, "Set concurrency limit for this link")
365 .def("set_host_wifi_rate", &simgrid::s4u::Link::set_host_wifi_rate,
366 "Set level of communication speed of given host on this Wi-Fi link")
367 .def("seal", &simgrid::s4u::Link::seal, "Seal this link")
368 .def_property_readonly(
370 [](const simgrid::s4u::Link* self) {
371 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
373 "The name of this link");
374 py::enum_<simgrid::s4u::Link::SharingPolicy>(link, "SharingPolicy")
375 .value("NONLINEAR", simgrid::s4u::Link::SharingPolicy::NONLINEAR)
376 .value("WIFI", simgrid::s4u::Link::SharingPolicy::WIFI)
377 .value("SPLITDUPLEX", simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX)
378 .value("SHARED", simgrid::s4u::Link::SharingPolicy::SHARED)
379 .value("FATPIPE", simgrid::s4u::Link::SharingPolicy::FATPIPE)
382 /* Class LinkInRoute */
383 py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
384 linkinroute.def(py::init<const simgrid::s4u::Link*>());
385 linkinroute.def(py::init<const simgrid::s4u::Link*, simgrid::s4u::LinkInRoute::Direction>());
386 py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
387 .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
388 .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
389 .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE)
392 /* Class Split-Duplex Link */
393 py::class_<simgrid::s4u::SplitDuplexLink, simgrid::s4u::Link,
394 std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(m, "SplitDuplexLink",
395 "Network split-duplex link")
396 .def("get_link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
397 .def("get_link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
400 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox")
402 "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
403 "Textual representation of the Mailbox`")
404 .def("by_name", &Mailbox::by_name, py::call_guard<GilScopedRelease>(), "Retrieve a Mailbox from its name")
405 .def_property_readonly(
407 [](const Mailbox* self) {
408 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
410 "The name of that mailbox")
413 [](Mailbox* self, py::object data, int size) {
415 self->put(data.ptr(), size);
417 py::call_guard<GilScopedRelease>(), "Blocking data transmission")
420 [](Mailbox* self, py::object data, int size) {
422 return self->put_async(data.ptr(), size);
424 py::call_guard<GilScopedRelease>(), "Non-blocking data transmission")
428 py::object data = pybind11::reinterpret_steal<py::object>(self->get<PyObject>());
429 // data.dec_ref(); // FIXME: why does it break python-actor-create?
432 py::call_guard<GilScopedRelease>(), "Blocking data reception")
435 [](Mailbox* self) -> std::tuple<simgrid::s4u::CommPtr, PyGetAsync> {
437 auto comm = self->get_async(wrap.get());
438 return std::make_tuple(std::move(comm), std::move(wrap));
440 py::call_guard<GilScopedRelease>(),
441 "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
443 "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); },
444 py::call_guard<GilScopedRelease>(), "Sets the actor as permanent receiver");
446 /* Class PyGetAsync */
447 py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
450 "get", [](const PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
451 "Get python object after async communication in receiver side");
454 py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm", "Communication")
455 .def("test", &simgrid::s4u::Comm::test, py::call_guard<GilScopedRelease>(),
456 "Test whether the communication is terminated.")
457 .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<GilScopedRelease>(),
458 "Block until the completion of that communication.")
459 // use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
460 .def_static("wait_all",
461 py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
462 py::call_guard<GilScopedRelease>(), "Block until the completion of all communications in the list.")
464 "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
465 py::call_guard<GilScopedRelease>(),
466 "Block until the completion of any communication in the list and return the index of the terminated one.");
469 py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities")
470 .def("test", &simgrid::s4u::Io::test, py::call_guard<GilScopedRelease>(), "Test whether the I/O is terminated.")
471 .def("wait", &simgrid::s4u::Io::wait, py::call_guard<GilScopedRelease>(),
472 "Block until the completion of that I/O operation")
474 "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard<GilScopedRelease>(),
475 "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.")
476 .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard<GilScopedRelease>(),
477 "Block until the completion of any I/O in the list and return the index of the terminated one.");
480 py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution")
481 .def_property_readonly(
483 [](simgrid::s4u::ExecPtr self) {
484 GilScopedRelease gil_guard;
485 return self->get_remaining();
487 "Amount of flops that remain to be computed until completion.")
488 .def_property_readonly(
490 [](simgrid::s4u::ExecPtr self) {
491 GilScopedRelease gil_guard;
492 return self->get_remaining_ratio();
494 "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
496 .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
497 "Host on which this execution runs. Only the first host is returned for parallel executions.")
498 .def("test", &simgrid::s4u::Exec::test, py::call_guard<GilScopedRelease>(),
499 "Test whether the execution is terminated.")
500 .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<GilScopedRelease>(), "Cancel that execution.")
501 .def("start", &simgrid::s4u::Exec::start, py::call_guard<GilScopedRelease>(), "Start that execution.")
502 .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<GilScopedRelease>(),
503 "Block until the completion of that execution.");
506 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
507 "An actor is an independent stream of execution in your distributed "
511 [](py::str name, Host* h, py::object fun, py::args args) {
512 fun.inc_ref(); // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
513 args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
514 return simgrid::s4u::Actor::create(name, h, [fun, args]() {
516 GilScopedAcquire py_context;
518 } catch (const py::error_already_set& ex) {
519 if (ex.matches(pyForcefulKillEx)) {
520 XBT_VERB("Actor killed");
521 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
527 py::call_guard<GilScopedRelease>(), "Create an actor from a function or an object.")
529 "host", &Actor::get_host,
530 [](Actor* a, Host* h) {
531 GilScopedRelease gil_guard;
534 "The host on which this actor is located")
535 .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
536 .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
537 .def_property_readonly("ppid", &Actor::get_ppid,
538 "The PID (unique identifier) of the actor that created this one.")
539 .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
540 .def("daemonize", &Actor::daemonize, py::call_guard<GilScopedRelease>(),
541 "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
543 .def("is_daemon", &Actor::is_daemon,
544 "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
546 .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<GilScopedRelease>(),
547 "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
548 .def("kill", &Actor::kill, py::call_guard<GilScopedRelease>(), "Kill that actor")
549 .def("kill_all", &Actor::kill_all, py::call_guard<GilScopedRelease>(), "Kill all actors but the caller.")
550 .def("self", &Actor::self, "Retrieves the current actor.")
551 .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
552 .def("suspend", &Actor::suspend, py::call_guard<GilScopedRelease>(),
553 "Suspend that actor, that is blocked until resume()ed by another actor.")
554 .def("resume", &Actor::resume, py::call_guard<GilScopedRelease>(),
555 "Resume that actor, that was previously suspend()ed.");