src/bindings/python/simgrid_python.cpp

   1 /* Copyright (c) 2018-2021. 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 #ifndef NDEBUG
  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
  20  *
  21  * The failing tests are mostly those with boost/raw/sysv contexts. As a workaround, define NDEBUG before pybind11
  22  * includes.
  23  */
  24 #define NDEBUG
  25 #define NDEBUG_LOCALLY_DEFINED
  26 #endif
  27
  28 #include <pybind11/pybind11.h> // Must come before our own stuff
  29
  30 #include <pybind11/functional.h>
  31 #include <pybind11/stl.h>
  32
  33 #ifdef NDEBUG_LOCALLY_DEFINED
  34 #undef NDEBUG_LOCALLY_DEFINED
  35 #undef NDEBUG
  36 #endif
  37
  38 #if defined(__GNUG__)
  39 #pragma GCC diagnostic pop
  40 #endif
  41
  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>
  55
  56 #include <algorithm>
  57 #include <memory>
  58 #include <string>
  59 #include <vector>
  60
  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;
  67
  68 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
  69
  70 namespace {
  71
  72 std::string get_simgrid_version()
  73 {
  74   int major;
  75   int minor;
  76   int patch;
  77   sg_version_get(&major, &minor, &patch);
  78   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
  79 }
  80
  81 /** @brief Wrap for mailbox::get_async */
  82 class PyGetAsync {
  83   std::unique_ptr<PyObject*> data = std::make_unique<PyObject*>();
  84
  85 public:
  86   PyObject** get() const { return data.get(); }
  87 };
  88
  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
  92  *
  93  * The pybind11 versions are however too sophisticated (using TLS for example) and don't work well with all kinds of
  94  * contexts.
  95  * See also https://github.com/pybind/pybind11/issues/1276, which may be related.
  96  *
  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.
  99  *
 100  * Like their pybind11 counterparts, both classes use a RAII pattern.
 101  */
 102 class XBT_PRIVATE GilScopedAcquire {
 103   static PyThreadState* acquire()
 104   {
 105     PyThreadState* state = PyThreadState_New(PyInterpreterState_Head());
 106     PyEval_AcquireThread(state);
 107     return state;
 108   }
 109   static void release(PyThreadState* state)
 110   {
 111     PyEval_ReleaseThread(state);
 112     PyThreadState_Clear(state);
 113     PyThreadState_Delete(state);
 114   }
 115
 116   std::unique_ptr<PyThreadState, decltype(&release)> thread_state{acquire(), &release};
 117 };
 118
 119 class XBT_PRIVATE GilScopedRelease {
 120   std::unique_ptr<PyThreadState, decltype(&PyEval_RestoreThread)> thread_state{PyEval_SaveThread(),
 121                                                                                &PyEval_RestoreThread};
 122 };
 123
 124 } // namespace
 125
 126 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
 127
 128 PYBIND11_MODULE(simgrid, m)
 129 {
 130   m.doc() = "SimGrid userspace API";
 131
 132   m.attr("simgrid_version") = get_simgrid_version();
 133
 134   // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
 135   static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
 136
 137   /* this_actor namespace */
 138   m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.")
 139       .def(
 140           "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
 141       .def(
 142           "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
 143       .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
 144            py::call_guard<GilScopedRelease>(),
 145            "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
 146            py::arg("priority") = 1)
 147       .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
 148            py::call_guard<GilScopedRelease>())
 149       .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
 150       .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<GilScopedRelease>(),
 151            "Moves the current actor to another host.", py::arg("dest"))
 152       .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
 153            py::call_guard<GilScopedRelease>(), "Block the actor sleeping for that amount of seconds.",
 154            py::arg("duration"))
 155       .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
 156            py::call_guard<GilScopedRelease>(), "Block the actor sleeping until the specified timestamp.",
 157            py::arg("duration"))
 158       .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<GilScopedRelease>(),
 159            "Suspend the current actor, that is blocked until resume()ed by another actor.")
 160       .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<GilScopedRelease>(), "Yield the actor")
 161       .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<GilScopedRelease>(), "kill the current actor")
 162       .def(
 163           "on_exit",
 164           [](py::object fun) {
 165             fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
 166             simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
 167               try {
 168                 GilScopedAcquire py_context; // need a new context for callback
 169                 fun();
 170               } catch (const py::error_already_set& e) {
 171                 xbt_die("Error while executing the on_exit lambda: %s", e.what());
 172               }
 173             });
 174           },
 175           py::call_guard<GilScopedRelease>(), "");
 176
 177   /* Class Engine */
 178   py::class_<Engine>(m, "Engine", "Simulation Engine")
 179       .def(py::init([](std::vector<std::string> args) {
 180         auto argc           = static_cast<int>(args.size());
 181         std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
 182         std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
 183         // Currently this can be dangling, we should wrap this somehow.
 184         return new simgrid::s4u::Engine(&argc, argv.data());
 185       }))
 186       .def_static("get_clock", &Engine::get_clock,
 187                   "The simulation time, ie the amount of simulated seconds since the simulation start.")
 188       .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
 189       .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
 190       .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
 191       .def("run", &Engine::run, py::call_guard<GilScopedRelease>(), "Run the simulation")
 192       .def(
 193           "register_actor",
 194           [](Engine* e, const std::string& name, py::object fun_or_class) {
 195             e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
 196               try {
 197                 GilScopedAcquire py_context;
 198                 /* Convert the std::vector into a py::tuple */
 199                 py::tuple params(args.size() - 1);
 200                 for (size_t i = 1; i < args.size(); i++)
 201                   params[i - 1] = py::cast(args[i]);
 202
 203                 py::object res = fun_or_class(*params);
 204                 /* If I was passed a class, I just built an instance, so I need to call it now */
 205                 if (py::isinstance<py::function>(res))
 206                   res();
 207               } catch (const py::error_already_set& ex) {
 208                 if (ex.matches(pyForcefulKillEx)) {
 209                   XBT_VERB("Actor killed");
 210                   simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
 211                 }
 212                 throw;
 213               }
 214             });
 215           },
 216           "Registers the main function of an actor");
 217
 218   /* Class Netzone */
 219   py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>> netzone(m, "NetZone",
 220                                                                                                   "Networking Zones");
 221   netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
 222       .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
 223       .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
 224       .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
 225       .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
 226       .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd")
 227       .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra")
 228       .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi")
 229       .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty")
 230       .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi")
 231       .def("add_route",
 232            py::overload_cast<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
 233                              simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
 234                              const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
 235            "Add a route between 2 netpoints")
 236       .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
 237            "Creates a host")
 238       .def("create_host",
 239            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
 240            "Creates a host")
 241       .def("create_host",
 242            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
 243            "Creates a host")
 244       .def("create_host",
 245            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
 246            "Creates a host")
 247       .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
 248            "Creates a network link")
 249       .def("create_link",
 250            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
 251            "Creates a network link")
 252       .def("create_link",
 253            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
 254            "Creates a network link")
 255       .def("create_link",
 256            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
 257            "Creates a network link")
 258       .def("create_split_duplex_link",
 259            py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
 260            "Creates a split-duplex link")
 261       .def("create_split_duplex_link",
 262            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
 263            "Creates a split-duplex link")
 264       .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
 265       .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
 266       .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
 267       .def("get_netpoint", &simgrid::s4u::NetZone::get_netpoint, "Retrieve the netpoint associated to this zone")
 268       .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
 269       .def_property_readonly(
 270           "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); }, "The name of this network zone");
 271
 272   /* Class ClusterCallbacks */
 273   py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
 274       .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
 275                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
 276                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
 277
 278   /* Class FatTreeParams */
 279   py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
 280       .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
 281                     const std::vector<unsigned int>&>());
 282
 283   /* Class DragonflyParams */
 284   py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
 285       .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
 286                     const std::pair<unsigned int, unsigned int>&, unsigned int>());
 287
 288   /* Class Host */
 289   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(m, "Host", "Simulated host");
 290   host.def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
 291       .def("get_pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
 292       .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
 293       .def("get_netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this host")
 294       .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
 295       .def("set_core_count", &Host::set_core_count, "Set the number of cores in the CPU")
 296       .def("set_coordinates", &Host::set_coordinates, "Set the coordinates of this host")
 297       .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, "Describe how the CPU is shared",
 298            py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 299       .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk), "Create a disk")
 300       .def("create_disk",
 301            py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
 302            "Create a disk")
 303       .def("seal", &Host::seal, "Seal this host")
 304       .def_property(
 305           "pstate", &Host::get_pstate,
 306           [](Host* h, int i) {
 307             GilScopedRelease gil_guard;
 308             h->set_pstate(i);
 309           },
 310           "The current pstate")
 311       .def("current", &Host::current, py::call_guard<GilScopedRelease>(),
 312            "Retrieves the host on which the running actor is located.")
 313       .def_property_readonly(
 314           "name",
 315           [](const Host* self) {
 316             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 317           },
 318           "The name of this host")
 319       .def_property_readonly(
 320           "load", &Host::get_load,
 321           "Returns the current computation load (in flops per second). This is the currently achieved speed.")
 322       .def_property_readonly(
 323           "speed", &Host::get_speed,
 324           "The peak computing speed in flops/s at the current pstate, taking the external load into account. "
 325           "This is the max potential speed.");
 326   py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
 327       .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
 328       .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR)
 329       .export_values();
 330
 331   /* Class Disk */
 332   py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(m, "Disk", "Simulated disk");
 333   disk.def("read", &simgrid::s4u::Disk::read, py::call_guard<GilScopedRelease>(), "Read data from disk")
 334       .def("write", &simgrid::s4u::Disk::write, py::call_guard<GilScopedRelease>(), "Write data in disk")
 335       .def("read_async", &simgrid::s4u::Disk::read_async, "Non-blocking read data from disk")
 336       .def("write_async", &simgrid::s4u::Disk::write_async, "Non-blocking write data in disk")
 337       .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, "Set sharing policy for this disk",
 338            py::arg("op"), py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 339       .def("seal", &simgrid::s4u::Disk::seal, "Seal this disk")
 340       .def_property_readonly(
 341           "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); }, "The name of this disk");
 342   py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
 343       .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
 344       .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR)
 345       .export_values();
 346   py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
 347       .value("READ", simgrid::s4u::Disk::Operation::READ)
 348       .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
 349       .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE)
 350       .export_values();
 351
 352   /* Class NetPoint */
 353   py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
 354       netpoint(m, "NetPoint", "NetPoint object");
 355
 356   /* Class Link */
 357   py::class_<simgrid::s4u::Link, std::unique_ptr<simgrid::s4u::Link, py::nodelete>> link(m, "Link", "Network link");
 358   link.def("set_latency", py::overload_cast<const std::string&>(&simgrid::s4u::Link::set_latency), "Set the latency")
 359       .def("set_latency", py::overload_cast<double>(&simgrid::s4u::Link::set_latency), "Set the latency")
 360       .def("set_sharing_policy", &simgrid::s4u::Link::set_sharing_policy, "Set sharing policy for this link")
 361       .def("set_concurrency_limit", &simgrid::s4u::Link::set_concurrency_limit, "Set concurrency limit for this link")
 362       .def("set_host_wifi_rate", &simgrid::s4u::Link::set_host_wifi_rate,
 363            "Set level of communication speed of given host on this Wi-Fi link")
 364       .def("seal", &simgrid::s4u::Link::seal, "Seal this link")
 365       .def_property_readonly(
 366           "name",
 367           [](const simgrid::s4u::Link* self) {
 368             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 369           },
 370           "The name of this link");
 371   py::enum_<simgrid::s4u::Link::SharingPolicy>(link, "SharingPolicy")
 372       .value("NONLINEAR", simgrid::s4u::Link::SharingPolicy::NONLINEAR)
 373       .value("WIFI", simgrid::s4u::Link::SharingPolicy::WIFI)
 374       .value("SPLITDUPLEX", simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX)
 375       .value("SHARED", simgrid::s4u::Link::SharingPolicy::SHARED)
 376       .value("FATPIPE", simgrid::s4u::Link::SharingPolicy::FATPIPE)
 377       .export_values();
 378
 379   /* Class LinkInRoute */
 380   py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
 381   linkinroute.def(py::init<const simgrid::s4u::Link*>());
 382   linkinroute.def(py::init<const simgrid::s4u::Link*, simgrid::s4u::LinkInRoute::Direction>());
 383   py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
 384       .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
 385       .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
 386       .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE)
 387       .export_values();
 388
 389   /* Class Split-Duplex Link */
 390   py::class_<simgrid::s4u::SplitDuplexLink, simgrid::s4u::Link,
 391              std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(m, "SplitDuplexLink",
 392                                                                            "Network split-duplex link")
 393       .def("get_link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
 394       .def("get_link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
 395
 396   /* Class Mailbox */
 397   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox")
 398       .def(
 399           "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
 400           "Textual representation of the Mailbox`")
 401       .def("by_name", &Mailbox::by_name, py::call_guard<GilScopedRelease>(), "Retrieve a Mailbox from its name")
 402       .def_property_readonly(
 403           "name",
 404           [](const Mailbox* self) {
 405             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 406           },
 407           "The name of that mailbox")
 408       .def(
 409           "put",
 410           [](Mailbox* self, py::object data, int size) {
 411             data.inc_ref();
 412             self->put(data.ptr(), size);
 413           },
 414           py::call_guard<GilScopedRelease>(), "Blocking data transmission")
 415       .def(
 416           "put_async",
 417           [](Mailbox* self, py::object data, int size) {
 418             data.inc_ref();
 419             return self->put_async(data.ptr(), size);
 420           },
 421           py::call_guard<GilScopedRelease>(), "Non-blocking data transmission")
 422       .def(
 423           "get",
 424           [](Mailbox* self) {
 425             py::object data = pybind11::reinterpret_steal<py::object>(self->get<PyObject>());
 426             // data.dec_ref(); // FIXME: why does it break python-actor-create?
 427             return data;
 428           },
 429           py::call_guard<GilScopedRelease>(), "Blocking data reception")
 430       .def(
 431           "get_async",
 432           [](Mailbox* self) -> std::tuple<simgrid::s4u::CommPtr, PyGetAsync> {
 433             PyGetAsync wrap;
 434             auto comm = self->get_async(wrap.get());
 435             return std::make_tuple(std::move(comm), std::move(wrap));
 436           },
 437           py::call_guard<GilScopedRelease>(),
 438           "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
 439       .def(
 440           "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); },
 441           py::call_guard<GilScopedRelease>(), "Sets the actor as permanent receiver");
 442
 443   /* Class PyGetAsync */
 444   py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
 445       .def(py::init<>())
 446       .def(
 447           "get", [](const PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
 448           "Get python object after async communication in receiver side");
 449
 450   /* Class Comm */
 451   py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm", "Communication")
 452       .def("test", &simgrid::s4u::Comm::test, py::call_guard<GilScopedRelease>(),
 453            "Test whether the communication is terminated.")
 454       .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<GilScopedRelease>(),
 455            "Block until the completion of that communication.")
 456       // use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
 457       .def_static("wait_all",
 458                   py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
 459                   py::call_guard<GilScopedRelease>(), "Block until the completion of all communications in the list.")
 460       .def_static(
 461           "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
 462           py::call_guard<GilScopedRelease>(),
 463           "Block until the completion of any communication in the list and return the index of the terminated one.");
 464
 465   /* Class Io */
 466   py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities")
 467       .def("test", &simgrid::s4u::Io::test, py::call_guard<GilScopedRelease>(), "Test whether the I/O is terminated.")
 468       .def("wait", &simgrid::s4u::Io::wait, py::call_guard<GilScopedRelease>(),
 469            "Block until the completion of that I/O operation")
 470       .def_static(
 471           "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard<GilScopedRelease>(),
 472           "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.")
 473       .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard<GilScopedRelease>(),
 474                   "Block until the completion of any I/O in the list and return the index of the terminated one.");
 475
 476   /* Class Exec */
 477   py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution")
 478       .def_property_readonly(
 479           "remaining",
 480           [](simgrid::s4u::ExecPtr self) {
 481             GilScopedRelease gil_guard;
 482             return self->get_remaining();
 483           },
 484           "Amount of flops that remain to be computed until completion.")
 485       .def_property_readonly(
 486           "remaining_ratio",
 487           [](simgrid::s4u::ExecPtr self) {
 488             GilScopedRelease gil_guard;
 489             return self->get_remaining_ratio();
 490           },
 491           "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
 492           "yet).")
 493       .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
 494                     "Host on which this execution runs. Only the first host is returned for parallel executions.")
 495       .def("test", &simgrid::s4u::Exec::test, py::call_guard<GilScopedRelease>(),
 496            "Test whether the execution is terminated.")
 497       .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<GilScopedRelease>(), "Cancel that execution.")
 498       .def("start", &simgrid::s4u::Exec::start, py::call_guard<GilScopedRelease>(), "Start that execution.")
 499       .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<GilScopedRelease>(),
 500            "Block until the completion of that execution.");
 501
 502   /* Class Actor */
 503   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 504                                             "An actor is an independent stream of execution in your distributed "
 505                                             "application")
 506       .def(
 507           "create",
 508           [](py::str name, Host* h, py::object fun, py::args args) {
 509             fun.inc_ref();  // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
 510             args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
 511             return simgrid::s4u::Actor::create(name, h, [fun, args]() {
 512               try {
 513                 GilScopedAcquire py_context;
 514                 fun(*args);
 515               } catch (const py::error_already_set& ex) {
 516                 if (ex.matches(pyForcefulKillEx)) {
 517                   XBT_VERB("Actor killed");
 518                   simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
 519                 }
 520                 throw;
 521               }
 522             });
 523           },
 524           py::call_guard<GilScopedRelease>(), "Create an actor from a function or an object.")
 525       .def_property(
 526           "host", &Actor::get_host,
 527           [](Actor* a, Host* h) {
 528             GilScopedRelease gil_guard;
 529             a->set_host(h);
 530           },
 531           "The host on which this actor is located")
 532       .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
 533       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
 534       .def_property_readonly("ppid", &Actor::get_ppid,
 535                              "The PID (unique identifier) of the actor that created this one.")
 536       .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
 537       .def("daemonize", &Actor::daemonize, py::call_guard<GilScopedRelease>(),
 538            "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
 539            "documentation).")
 540       .def("is_daemon", &Actor::is_daemon,
 541            "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
 542            "terminates.")
 543       .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<GilScopedRelease>(),
 544            "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
 545       .def("kill", &Actor::kill, py::call_guard<GilScopedRelease>(), "Kill that actor")
 546       .def("kill_all", &Actor::kill_all, py::call_guard<GilScopedRelease>(), "Kill all actors but the caller.")
 547       .def("self", &Actor::self, "Retrieves the current actor.")
 548       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
 549       .def("suspend", &Actor::suspend, py::call_guard<GilScopedRelease>(),
 550            "Suspend that actor, that is blocked until resume()ed by another actor.")
 551       .def("resume", &Actor::resume, py::call_guard<GilScopedRelease>(),
 552            "Resume that actor, that was previously suspend()ed.");
 553 }