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