src/bindings/python/simgrid_python.cpp

   1 /* Copyright (c) 2018-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifdef _WIN32
   7 #warning Try to work around https://bugs.python.org/issue11566
   8 #define _hypot hypot
   9 #endif
  10
  11 #if defined(__GNUG__)
  12 #pragma GCC diagnostic push
  13 #pragma GCC diagnostic ignored "-Wunused-value"
  14 #endif
  15
  16 #include <pybind11/pybind11.h> // Must come before our own stuff
  17
  18 #include <pybind11/functional.h>
  19 #include <pybind11/stl.h>
  20
  21 #if defined(__GNUG__)
  22 #pragma GCC diagnostic pop
  23 #endif
  24
  25 #include "simgrid/kernel/ProfileBuilder.hpp"
  26 #include "simgrid/kernel/routing/NetPoint.hpp"
  27 #include <simgrid/Exception.hpp>
  28 #include <simgrid/s4u/Actor.hpp>
  29 #include <simgrid/s4u/Barrier.hpp>
  30 #include <simgrid/s4u/Comm.hpp>
  31 #include <simgrid/s4u/Disk.hpp>
  32 #include <simgrid/s4u/Engine.hpp>
  33 #include <simgrid/s4u/Exec.hpp>
  34 #include <simgrid/s4u/Host.hpp>
  35 #include <simgrid/s4u/Link.hpp>
  36 #include <simgrid/s4u/Mailbox.hpp>
  37 #include <simgrid/s4u/Mutex.hpp>
  38 #include <simgrid/s4u/NetZone.hpp>
  39 #include <simgrid/version.h>
  40
  41 #include <algorithm>
  42 #include <memory>
  43 #include <string>
  44 #include <vector>
  45
  46 namespace py = pybind11;
  47 using simgrid::s4u::Actor;
  48 using simgrid::s4u::ActorPtr;
  49 using simgrid::s4u::Barrier;
  50 using simgrid::s4u::BarrierPtr;
  51 using simgrid::s4u::Engine;
  52 using simgrid::s4u::Host;
  53 using simgrid::s4u::Link;
  54 using simgrid::s4u::Mailbox;
  55 using simgrid::s4u::Mutex;
  56 using simgrid::s4u::MutexPtr;
  57
  58 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
  59
  60 namespace {
  61
  62 std::string get_simgrid_version()
  63 {
  64   int major;
  65   int minor;
  66   int patch;
  67   sg_version_get(&major, &minor, &patch);
  68   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
  69 }
  70
  71 /** @brief Wrap for mailbox::get_async */
  72 class PyGetAsync {
  73   std::unique_ptr<PyObject*> data = std::make_unique<PyObject*>();
  74
  75 public:
  76   PyObject** get() const { return data.get(); }
  77 };
  78
  79 } // namespace
  80
  81 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
  82
  83 PYBIND11_MODULE(simgrid, m)
  84 {
  85   m.doc() = "SimGrid userspace API";
  86
  87   m.attr("simgrid_version") = get_simgrid_version();
  88
  89   // Swapped contexts are broken, starting from pybind11 v2.8.0.  Use thread contexts by default.
  90   simgrid::s4u::Engine::set_config("contexts/factory:thread");
  91
  92   // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
  93   static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
  94
  95   py::register_exception<simgrid::NetworkFailureException>(m, "NetworkFailureException");
  96   py::register_exception<simgrid::TimeoutException>(m, "TimeoutException");
  97   py::register_exception<simgrid::HostFailureException>(m, "HostFailureException");
  98   py::register_exception<simgrid::StorageFailureException>(m, "StorageFailureException");
  99   py::register_exception<simgrid::VmFailureException>(m, "VmFailureException");
 100   py::register_exception<simgrid::CancelException>(m, "CancelException");
 101
 102   /* this_actor namespace */
 103   m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.")
 104       .def(
 105           "debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.")
 106       .def(
 107           "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
 108       .def(
 109           "warning", [](const char* s) { XBT_WARN("%s", s); }, "Display a logging message of 'warning' priority.")
 110       .def(
 111           "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
 112       .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
 113            py::call_guard<py::gil_scoped_release>(),
 114            "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
 115            py::arg("priority") = 1)
 116       .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
 117            py::call_guard<py::gil_scoped_release>())
 118       .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
 119       .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<py::gil_scoped_release>(),
 120            "Moves the current actor to another host.", py::arg("dest"))
 121       .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
 122            py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping for that amount of seconds.",
 123            py::arg("duration"))
 124       .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
 125            py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping until the specified timestamp.",
 126            py::arg("duration"))
 127       .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<py::gil_scoped_release>(),
 128            "Suspend the current actor, that is blocked until resume()ed by another actor.")
 129       .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<py::gil_scoped_release>(), "Yield the actor")
 130       .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<py::gil_scoped_release>(), "kill the current actor")
 131       .def(
 132           "on_exit",
 133           [](py::object cb) {
 134             py::function fun = py::reinterpret_borrow<py::function>(cb);
 135             fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
 136             simgrid::s4u::this_actor::on_exit([fun](bool failed) {
 137               py::gil_scoped_acquire py_context; // need a new context for callback
 138               try {
 139                 fun(failed);
 140               } catch (const py::error_already_set& e) {
 141                 xbt_die("Error while executing the on_exit lambda: %s", e.what());
 142               }
 143             });
 144           },
 145           py::call_guard<py::gil_scoped_release>(),
 146           "Define a lambda to be called when the actor ends. It takes a bool parameter indicating whether the actor "
 147           "was killed. If False, the actor finished peacefully.")
 148       .def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
 149       .def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
 150            "Retrieves PPID of the current actor (i.e., the PID of its parent).");
 151
 152   /* Class Engine */
 153   py::class_<Engine>(m, "Engine", "Simulation Engine")
 154       .def(py::init([](std::vector<std::string> args) {
 155              auto argc = static_cast<int>(args.size());
 156              std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
 157              std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
 158              // Currently this can be dangling, we should wrap this somehow.
 159              return new simgrid::s4u::Engine(&argc, argv.data());
 160            }),
 161            "The constructor should take the parameters from the command line, as is ")
 162       .def_static("get_clock",
 163                   []() // XBT_ATTRIB_DEPRECATED_v334
 164                   {
 165                     PyErr_WarnEx(
 166                         PyExc_DeprecationWarning,
 167                         "get_clock() is deprecated and  will be dropped after v3.33, use `Engine.clock` instead.", 1);
 168                     return Engine::get_clock();
 169                   })
 170       .def_property_readonly_static(
 171           "clock", [](py::object /* self */) { return Engine::get_clock(); },
 172           "The simulation time, ie the amount of simulated seconds since the simulation start.")
 173       .def_property_readonly_static(
 174           "instance", [](py::object /* self */) { return Engine::get_instance(); }, "Retrieve the simulation engine")
 175       .def("get_all_hosts",
 176            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 177            {
 178              PyErr_WarnEx(PyExc_DeprecationWarning,
 179                           "get_all_hosts() is deprecated and  will be dropped after v3.33, use all_hosts instead.", 1);
 180              return self.attr("all_hosts");
 181            })
 182       .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
 183       .def("get_all_links",
 184            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 185            {
 186              PyErr_WarnEx(PyExc_DeprecationWarning,
 187                           "get_all_links() is deprecated and  will be dropped after v3.33, use all_links instead.", 1);
 188              return self.attr("all_links");
 189            })
 190       .def_property_readonly("all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
 191       .def("get_all_netpoints",
 192            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 193            {
 194              PyErr_WarnEx(
 195                  PyExc_DeprecationWarning,
 196                  "get_all_netpoints() is deprecated and  will be dropped after v3.33, use all_netpoints instead.", 1);
 197              return self.attr("all_netpoints");
 198            })
 199       .def_property_readonly("all_netpoints", &Engine::get_all_netpoints)
 200       .def("get_netzone_root",
 201            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 202            {
 203              PyErr_WarnEx(PyExc_DeprecationWarning,
 204                           "get_netzone_root() is deprecated and  will be dropped after v3.3, use netzone_root instead.",
 205                           1);
 206              return self.attr("netzone_root");
 207            })
 208       .def_property_readonly("netzone_root", &Engine::get_netzone_root,
 209                              "Retrieve the root netzone, containing all others.")
 210       .def("netpoint_by_name", &Engine::netpoint_by_name_or_null)
 211       .def("netzone_by_name", &Engine::netzone_by_name_or_null)
 212       .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
 213       .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
 214       .def("run", &Engine::run, py::call_guard<py::gil_scoped_release>(), "Run the simulation until its end")
 215       .def("run_until", py::overload_cast<double>(&Engine::run_until, py::const_),
 216            py::call_guard<py::gil_scoped_release>(), "Run the simulation until the given date",
 217            py::arg("max_date") = -1)
 218       .def(
 219           "register_actor",
 220           [](Engine* e, const std::string& name, py::object fun_or_class) {
 221             e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
 222               py::gil_scoped_acquire py_context;
 223               try {
 224                 /* Convert the std::vector into a py::tuple */
 225                 py::tuple params(args.size() - 1);
 226                 for (size_t i = 1; i < args.size(); i++)
 227                   params[i - 1] = py::cast(args[i]);
 228
 229                 py::object res = fun_or_class(*params);
 230                 /* If I was passed a class, I just built an instance, so I need to call it now */
 231                 if (py::isinstance<py::function>(res))
 232                   res();
 233               } catch (const py::error_already_set& ex) {
 234                 if (ex.matches(pyForcefulKillEx)) {
 235                   XBT_VERB("Actor killed");
 236                   simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
 237                 }
 238                 throw;
 239               }
 240             });
 241           },
 242           "Registers the main function of an actor");
 243
 244   /* Class Netzone */
 245   py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>> netzone(
 246       m, "NetZone", "Networking Zones. See the C++ documentation for details.");
 247   netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
 248       .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
 249       .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
 250       .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
 251       .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
 252       .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd")
 253       .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra")
 254       .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi")
 255       .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty")
 256       .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi")
 257       .def("add_route",
 258            py::overload_cast<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
 259                              simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
 260                              const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
 261            "Add a route between 2 netpoints")
 262       .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
 263            "Creates a host")
 264       .def("create_host",
 265            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
 266            "Creates a host")
 267       .def("create_host",
 268            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
 269            "Creates a host")
 270       .def("create_host",
 271            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
 272            "Creates a host")
 273       .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
 274            "Creates a network link")
 275       .def("create_link",
 276            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
 277            "Creates a network link")
 278       .def("create_link",
 279            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
 280            "Creates a network link")
 281       .def("create_link",
 282            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
 283            "Creates a network link")
 284       .def("create_split_duplex_link",
 285            py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
 286            "Creates a split-duplex link")
 287       .def("create_split_duplex_link",
 288            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
 289            "Creates a split-duplex link")
 290       .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
 291       .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
 292       .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
 293       .def("get_netpoint",
 294            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 295            {
 296              PyErr_WarnEx(PyExc_DeprecationWarning,
 297                           "get_netpoint() is deprecated and  will be dropped after v3.33, use netpoint instead.", 1);
 298              return self.attr("netpoint");
 299            })
 300       .def_property_readonly("netpoint", &simgrid::s4u::NetZone::get_netpoint,
 301                              "Retrieve the netpoint associated to this zone")
 302       .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
 303       .def_property_readonly(
 304           "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); },
 305           "The name of this network zone (read-only property).");
 306
 307   /* Class ClusterCallbacks */
 308   py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
 309       .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
 310                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
 311                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
 312
 313   /* Class FatTreeParams */
 314   py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
 315       .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
 316                     const std::vector<unsigned int>&>());
 317
 318   /* Class DragonflyParams */
 319   py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
 320       .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
 321                     const std::pair<unsigned int, unsigned int>&, unsigned int>());
 322
 323   /* Class Host */
 324   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
 325       m, "Host", "Simulated host. See the C++ documentation for details.");
 326   host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die")
 327       .def(
 328           "route_to",
 329           [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
 330             auto* list = new std::vector<Link*>();
 331             double bw  = 0;
 332             h->route_to(to, *list, &bw);
 333             return make_tuple(list, bw);
 334           },
 335           "Retrieves the list of links and the bandwidth between two hosts.")
 336       .def(
 337           "set_speed_profile",
 338           [](Host* h, const std::string& profile, double period) {
 339             h->set_speed_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 340           },
 341           py::call_guard<py::gil_scoped_release>(),
 342           "Specify a profile modeling the external load according to an exhaustive list. "
 343           "Each line of the profile describes timed events as ``date ratio``. "
 344           "For example, the following content describes an host which computational speed is initially 1 (i.e, 100%) "
 345           "and then halved after 42 seconds:\n\n"
 346           ".. code-block:: python\n\n"
 347           "   \"\"\"\n"
 348           "   0 1.0\n"
 349           "   42 0.5\n"
 350           "   \"\"\"\n\n"
 351           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 352           " while speed profiles of hosts contain ratios.\n\n"
 353           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 354           "the list. Set it to -1 to not loop over.")
 355       .def(
 356           "set_state_profile",
 357           [](Host* h, const std::string& profile, double period) {
 358             h->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 359           },
 360           py::call_guard<py::gil_scoped_release>(),
 361           "Specify a profile modeling the churn. "
 362           "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
 363           "whether the host is on. "
 364           "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
 365           ".. code-block:: python\n\n"
 366           "   \"\"\"\n"
 367           "   1.0 0\n"
 368           "   2.0 1\n"
 369           "   \"\"\"\n\n"
 370           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 371           "the list. Set it to -1 to not loop over.")
 372       .def("get_pstate_count",
 373            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 374            {
 375              PyErr_WarnEx(
 376                  PyExc_DeprecationWarning,
 377                  "get_pstate_count() is deprecated and  will be dropped after v3.33, use pstate_count instead.", 1);
 378              return self.attr("pstate_count");
 379            })
 380       .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
 381       .def("get_pstate_speed",
 382            [](py::object self, int state) // XBT_ATTRIB_DEPRECATED_v334
 383            {
 384              PyErr_WarnEx(
 385                  PyExc_DeprecationWarning,
 386                  "get_pstate_speed() is deprecated and  will be dropped after v3.33, use pstate_speed instead.", 1);
 387              return self.attr("pstate_speed")(state);
 388            })
 389       .def("pstate_speed", &Host::get_pstate_speed, py::call_guard<py::gil_scoped_release>(),
 390            "Retrieve the maximal speed at the given pstate")
 391       .def("get_netpoint",
 392            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 393            {
 394              PyErr_WarnEx(PyExc_DeprecationWarning,
 395                           "get_netpoint() is deprecated and  will be dropped after v3.33, use netpoint instead.", 1);
 396              return self.attr("netpoint");
 397            })
 398       .def_property_readonly("netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this zone")
 399       .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
 400       .def("set_core_count",
 401            [](py::object self, double count) // XBT_ATTRIB_DEPRECATED_v334
 402            {
 403              PyErr_WarnEx(PyExc_DeprecationWarning,
 404                           "set_core_count() is deprecated and  will be dropped after v3.33, use core_count instead.",
 405                           1);
 406              self.attr("core_count")(count);
 407            })
 408       .def_property(
 409           "core_count", &Host::get_core_count,
 410           [](Host* h, int count) {
 411             py::gil_scoped_release gil_guard;
 412             return h->set_core_count(count);
 413           },
 414           "Manage the number of cores in the CPU")
 415       .def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
 416            "Set the coordinates of this host")
 417       .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 418            "Describe how the CPU is shared", py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 419       .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk),
 420            py::call_guard<py::gil_scoped_release>(), "Create a disk")
 421       .def("create_disk",
 422            py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
 423            py::call_guard<py::gil_scoped_release>(), "Create a disk")
 424       .def("seal", &Host::seal, py::call_guard<py::gil_scoped_release>(), "Seal this host")
 425       .def_property(
 426           "pstate", &Host::get_pstate,
 427           [](Host* h, int i) {
 428             py::gil_scoped_release gil_guard;
 429             h->set_pstate(i);
 430           },
 431           "The current pstate (read/write property).")
 432       .def_static("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
 433            "Retrieves the host on which the running actor is located.")
 434       .def_property_readonly(
 435           "name",
 436           [](const Host* self) {
 437             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 438           },
 439           "The name of this host (read-only property).")
 440       .def_property_readonly("load", &Host::get_load,
 441                              "Returns the current computation load (in flops per second), NOT taking the external load "
 442                              "into account. This is the currently achieved speed (read-only property).")
 443       .def_property_readonly(
 444           "speed", &Host::get_speed,
 445           "The peak computing speed in flops/s at the current pstate, NOT taking the external load into account. "
 446           "This is the max potential speed (read-only property).")
 447       .def_property_readonly("available_speed", &Host::get_available_speed,
 448                              "Get the available speed ratio, between 0 and 1.\n"
 449                              "This accounts for external load (see :py:func:`set_speed_profile() "
 450                              "<simgrid.Host.set_speed_profile>`) (read-only property).")
 451       .def_static(
 452           "on_creation_cb",
 453           [](py::object cb) {
 454             Host::on_creation_cb([cb](Host& h) {
 455               py::function fun = py::reinterpret_borrow<py::function>(cb);
 456               py::gil_scoped_acquire py_context; // need a new context for callback
 457               try {
 458                 fun(&h);
 459               } catch (const py::error_already_set& e) {
 460                 xbt_die("Error while executing the on_creation lambda : %s", e.what());
 461               }
 462             });
 463           },
 464           py::call_guard<py::gil_scoped_release>(), "");
 465
 466   py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
 467       .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
 468       .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR)
 469       .export_values();
 470
 471   /* Class Disk */
 472   py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(
 473       m, "Disk", "Simulated disk. See the C++ documentation for details.");
 474   disk.def("read", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::read, py::const_),
 475            py::call_guard<py::gil_scoped_release>(), "Read data from disk", py::arg("size"), py::arg("priority") = 1)
 476       .def("write", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::write, py::const_),
 477            py::call_guard<py::gil_scoped_release>(), "Write data in disk", py::arg("size"), py::arg("priority") = 1)
 478       .def("read_async", &simgrid::s4u::Disk::read_async, py::call_guard<py::gil_scoped_release>(),
 479            "Non-blocking read data from disk")
 480       .def("write_async", &simgrid::s4u::Disk::write_async, py::call_guard<py::gil_scoped_release>(),
 481            "Non-blocking write data in disk")
 482       .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 483            "Set sharing policy for this disk", py::arg("op"), py::arg("policy"),
 484            py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 485       .def("seal", &simgrid::s4u::Disk::seal, py::call_guard<py::gil_scoped_release>(), "Seal this disk")
 486       .def_property_readonly(
 487           "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); },
 488           "The name of this disk (read-only property).");
 489   py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
 490       .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
 491       .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR)
 492       .export_values();
 493   py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
 494       .value("READ", simgrid::s4u::Disk::Operation::READ)
 495       .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
 496       .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE)
 497       .export_values();
 498
 499   /* Class NetPoint */
 500   py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
 501       netpoint(m, "NetPoint", "NetPoint object");
 502
 503   /* Class Link */
 504   py::class_<Link, std::unique_ptr<Link, py::nodelete>> link(m, "Link",
 505                                                              "Network link. See the C++ documentation for details.");
 506   link.def("set_latency", py::overload_cast<const std::string&>(&Link::set_latency),
 507            py::call_guard<py::gil_scoped_release>(),
 508            "Set the latency as a string. Accepts values with units, such as ‘1s’ or ‘7ms’.\nFull list of accepted "
 509            "units: w (week), d (day), h, s, ms, us, ns, ps.")
 510       .def("set_latency", py::overload_cast<double>(&Link::set_latency), py::call_guard<py::gil_scoped_release>(),
 511            "Set the latency as a float (in seconds).")
 512       .def("set_bandwidth", &Link::set_bandwidth, py::call_guard<py::gil_scoped_release>(),
 513            "Set the bandwidth (in byte per second).")
 514       .def(
 515           "set_bandwidth_profile",
 516           [](Link* l, const std::string& profile, double period) {
 517             l->set_bandwidth_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 518           },
 519           py::call_guard<py::gil_scoped_release>(),
 520           "Specify a profile modeling the external load according to an exhaustive list. "
 521           "Each line of the profile describes timed events as ``date bandwidth`` (in bytes per second). "
 522           "For example, the following content describes a link which bandwidth changes to 40 Mb/s at t=4, and to 6 "
 523           "Mb/s at t=8:\n\n"
 524           ".. code-block:: python\n\n"
 525           "   \"\"\"\n"
 526           "   4.0 40000000\n"
 527           "   8.0 60000000\n"
 528           "   \"\"\"\n\n"
 529           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 530           " while speed profiles of hosts contain ratios.\n\n"
 531           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 532           "the list. Set it to -1 to not loop over.")
 533       .def(
 534           "set_latency_profile",
 535           [](Link* l, const std::string& profile, double period) {
 536             l->set_latency_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 537           },
 538           py::call_guard<py::gil_scoped_release>(),
 539           "Specify a profile modeling the external load according to an exhaustive list. "
 540           "Each line of the profile describes timed events as ``date latency`` (in seconds). "
 541           "For example, the following content describes a link which latency changes to 1ms (0.001s) at t=1, and to 2s "
 542           "at t=2:\n\n"
 543           ".. code-block:: python\n\n"
 544           "   \"\"\"\n"
 545           "   1.0 0.001\n"
 546           "   2.0 2\n"
 547           "   \"\"\"\n\n"
 548           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 549           " while speed profiles of hosts contain ratios.\n\n"
 550           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 551           "the list. Set it to -1 to not loop over.")
 552       .def(
 553           "set_state_profile",
 554           [](Link* l, const std::string& profile, double period) {
 555             l->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 556           },
 557           "Specify a profile modeling the churn. "
 558           "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
 559           "whether the link is on. "
 560           "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
 561           ".. code-block:: python\n\n"
 562           "   \"\"\"\n"
 563           "   1.0 0\n"
 564           "   2.0 1\n"
 565           "   \"\"\"\n\n"
 566           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 567           "the list. Set it to -1 to not loop over.")
 568
 569       .def("turn_on", &Link::turn_on, py::call_guard<py::gil_scoped_release>(), "Turns the link on.")
 570       .def("turn_off", &Link::turn_off, py::call_guard<py::gil_scoped_release>(), "Turns the link off.")
 571       .def("is_on", &Link::is_on, "Check whether the link is on.")
 572
 573       .def("set_sharing_policy", &Link::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 574            "Set sharing policy for this link")
 575       .def("set_concurrency_limit", &Link::set_concurrency_limit, py::call_guard<py::gil_scoped_release>(),
 576            "Set concurrency limit for this link")
 577       .def("set_host_wifi_rate", &Link::set_host_wifi_rate, py::call_guard<py::gil_scoped_release>(),
 578            "Set level of communication speed of given host on this Wi-Fi link")
 579       .def_static("by_name", &Link::by_name, "Retrieves a Link from its name, or dies")
 580       .def("seal", &Link::seal, py::call_guard<py::gil_scoped_release>(), "Seal this link")
 581       .def_property_readonly(
 582           "name",
 583           [](const Link* self) {
 584             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 585           },
 586           "The name of this link")
 587       .def_property_readonly("bandwidth", &Link::get_bandwidth,
 588                              "The bandwidth (in bytes per second) (read-only property).")
 589       .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property).");
 590
 591   py::enum_<Link::SharingPolicy>(link, "SharingPolicy")
 592       .value("NONLINEAR", Link::SharingPolicy::NONLINEAR)
 593       .value("WIFI", Link::SharingPolicy::WIFI)
 594       .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX)
 595       .value("SHARED", Link::SharingPolicy::SHARED)
 596       .value("FATPIPE", Link::SharingPolicy::FATPIPE)
 597       .export_values();
 598
 599   /* Class LinkInRoute */
 600   py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
 601   linkinroute.def(py::init<const Link*>());
 602   linkinroute.def(py::init<const Link*, simgrid::s4u::LinkInRoute::Direction>());
 603   py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
 604       .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
 605       .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
 606       .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE)
 607       .export_values();
 608
 609   /* Class Split-Duplex Link */
 610   py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
 611       m, "SplitDuplexLink", "Network split-duplex link")
 612       .def("get_link_up",
 613            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 614            {
 615              PyErr_WarnEx(PyExc_DeprecationWarning,
 616                           "get_link_up() is deprecated and  will be dropped after v3.33, use link_up instead.", 1);
 617              return self.attr("link_up");
 618            })
 619       .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
 620       .def("get_link_down",
 621            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 622            {
 623              PyErr_WarnEx(PyExc_DeprecationWarning,
 624                           "get_link_down() is deprecated and  will be dropped after v3.33, use link_down instead.", 1);
 625              return self.attr("link_down");
 626            })
 627       .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
 628
 629   /* Class Mailbox */
 630   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
 631       m, "Mailbox", "Mailbox. See the C++ documentation for details.")
 632       .def(
 633           "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
 634           "Textual representation of the Mailbox`")
 635       .def_static("by_name", &Mailbox::by_name,
 636                   py::call_guard<py::gil_scoped_release>(),
 637                   py::arg("name"),
 638                   "Retrieve a Mailbox from its name")
 639       .def_property_readonly(
 640           "name",
 641           [](const Mailbox* self) {
 642             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 643           },
 644           "The name of that mailbox (read-only property).")
 645       .def(
 646           "put",
 647           [](Mailbox* self, py::object data, int size, double timeout) {
 648             data.inc_ref();
 649             self->put(data.ptr(), size, timeout);
 650           },
 651           py::call_guard<py::gil_scoped_release>(), "Blocking data transmission with a timeout")
 652       .def(
 653           "put",
 654           [](Mailbox* self, py::object data, int size) {
 655             data.inc_ref();
 656             self->put(data.ptr(), size);
 657           },
 658           py::call_guard<py::gil_scoped_release>(), "Blocking data transmission")
 659       .def(
 660           "put_async",
 661           [](Mailbox* self, py::object data, int size) {
 662             data.inc_ref();
 663             return self->put_async(data.ptr(), size);
 664           },
 665           py::call_guard<py::gil_scoped_release>(), "Non-blocking data transmission")
 666       .def(
 667           "put_init",
 668           [](Mailbox* self, py::object data, int size) {
 669             data.inc_ref();
 670             return self->put_init(data.ptr(), size);
 671           },
 672           py::call_guard<py::gil_scoped_release>(),
 673           "Creates (but don’t start) a data transmission to that mailbox.")
 674       .def(
 675           "get",
 676           [](Mailbox* self) {
 677             py::object data = py::reinterpret_steal<py::object>(self->get<PyObject>());
 678             // data.dec_ref(); // FIXME: why does it break python-actor-create?
 679             return data;
 680           },
 681           py::call_guard<py::gil_scoped_release>(), "Blocking data reception")
 682       .def(
 683           "get_async",
 684           [](Mailbox* self) -> std::tuple<simgrid::s4u::CommPtr, PyGetAsync> {
 685             PyGetAsync wrap;
 686             auto comm = self->get_async(wrap.get());
 687             return std::make_tuple(std::move(comm), std::move(wrap));
 688           },
 689           py::call_guard<py::gil_scoped_release>(),
 690           "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
 691       .def(
 692           "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); },
 693           py::call_guard<py::gil_scoped_release>(), "Sets the actor as permanent receiver");
 694
 695   /* Class PyGetAsync */
 696   py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
 697       .def(py::init<>())
 698       .def(
 699           "get", [](const PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
 700           "Get python object after async communication in receiver side");
 701
 702   /* Class Comm */
 703   py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
 704                                                         "Communication. See the C++ documentation for details.")
 705       .def("test", &simgrid::s4u::Comm::test, py::call_guard<py::gil_scoped_release>(),
 706            "Test whether the communication is terminated.")
 707       .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<py::gil_scoped_release>(),
 708            "Block until the completion of that communication.")
 709       .def("wait_for", &simgrid::s4u::Comm::wait_for,
 710            py::arg("timeout"),
 711            py::call_guard<py::gil_scoped_release>(),
 712            "Block until the completion of that communication, or raises TimeoutException after the specified timeout.")
 713       .def("detach", [](simgrid::s4u::Comm* self) {
 714               return self->detach();
 715            },
 716            py::return_value_policy::reference_internal,
 717            py::call_guard<py::gil_scoped_release>(),
 718            "Start the comm, and ignore its result. It can be completely forgotten after that.")
 719       // use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
 720       .def_static(
 721           "wait_all", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
 722           py::arg("comms"),
 723           py::call_guard<py::gil_scoped_release>(),
 724           "Block until the completion of all communications in the list.")
 725       .def_static("wait_all_for", &simgrid::s4u::Comm::wait_all_for,
 726                   py::arg("comms"), py::arg("timeout"),
 727                   py::call_guard<py::gil_scoped_release>(),
 728                   "Block until the completion of all communications in the list, or raises TimeoutException after "
 729                   "the specified timeout.")
 730       .def_static(
 731           "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
 732           py::arg("comms"),
 733           py::call_guard<py::gil_scoped_release>(),
 734           "Block until the completion of any communication in the list and return the index of the terminated one.")
 735       .def_static(
 736           "wait_any_for",
 737           py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&, double>(&simgrid::s4u::Comm::wait_any_for),
 738           py::arg("comms"), py::arg("timeout"),
 739           py::call_guard<py::gil_scoped_release>(),
 740           "Block until the completion of any communication in the list and return the index of the terminated "
 741           "one, or -1 if a timeout occurred."
 742       );
 743
 744   /* Class Io */
 745   py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities. See the C++ documentation for details.")
 746       .def("test", &simgrid::s4u::Io::test, py::call_guard<py::gil_scoped_release>(),
 747            "Test whether the I/O is terminated.")
 748       .def("wait", &simgrid::s4u::Io::wait, py::call_guard<py::gil_scoped_release>(),
 749            "Block until the completion of that I/O operation")
 750       .def_static(
 751           "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard<py::gil_scoped_release>(),
 752           "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.")
 753       .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard<py::gil_scoped_release>(),
 754                   "Block until the completion of any I/O in the list and return the index of the terminated one.");
 755
 756   /* Class Exec */
 757   py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution. See the C++ documentation for details.")
 758       .def_property_readonly(
 759           "remaining",
 760           [](simgrid::s4u::ExecPtr self) {
 761             py::gil_scoped_release gil_guard;
 762             return self->get_remaining();
 763           },
 764           "Amount of flops that remain to be computed until completion (read-only property).")
 765       .def_property_readonly(
 766           "remaining_ratio",
 767           [](simgrid::s4u::ExecPtr self) {
 768             py::gil_scoped_release gil_guard;
 769             return self->get_remaining_ratio();
 770           },
 771           "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
 772           "yet) (read-only property).")
 773       .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
 774                     "Host on which this execution runs. Only the first host is returned for parallel executions. "
 775                     "Changing this value migrates the execution.")
 776       .def("test", &simgrid::s4u::Exec::test, py::call_guard<py::gil_scoped_release>(),
 777            "Test whether the execution is terminated.")
 778       .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<py::gil_scoped_release>(), "Cancel that execution.")
 779       .def("start", &simgrid::s4u::Exec::start, py::call_guard<py::gil_scoped_release>(), "Start that execution.")
 780       .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<py::gil_scoped_release>(),
 781            "Block until the completion of that execution.");
 782
 783   /* Class Mutex */
 784   py::class_<Mutex, MutexPtr>(m, "Mutex",
 785                               "A classical mutex, but blocking in the simulation world."
 786                               "See the C++ documentation for details.")
 787       .def(py::init<>(&Mutex::create))
 788       .def("lock", &Mutex::lock, py::call_guard<py::gil_scoped_release>(), "Block until the mutex is acquired.")
 789       .def("try_lock", &Mutex::try_lock, py::call_guard<py::gil_scoped_release>(),
 790            "Try to acquire the mutex. Return true if the mutex was acquired, false otherwise.")
 791       .def("unlock", &Mutex::unlock, py::call_guard<py::gil_scoped_release>(), "Release the mutex")
 792       // Allow mutexes to be automatically acquired/released with a context manager: `with mutex: ...`
 793       .def("__enter__", [](Mutex* self){ self->lock(); }, py::call_guard<py::gil_scoped_release>())
 794       .def("__exit__", [](Mutex* self, py::object&, py::object&, py::object&){ self->unlock(); },
 795           py::call_guard<py::gil_scoped_release>());
 796
 797   /* Class Barrier */
 798   py::class_<Barrier, BarrierPtr>(m, "Barrier",
 799                                   "A classical barrier, but blocking in the simulation world.")
 800       .def(py::init<>(&Barrier::create), py::call_guard<py::gil_scoped_release>(), py::arg("expected_actors"))
 801       .def("wait", &Barrier::wait, py::call_guard<py::gil_scoped_release>(),
 802            "Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches "
 803            "the barrier");
 804
 805   /* Class Actor */
 806   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 807                                             "An actor is an independent stream of execution in your distributed "
 808                                             "application. See the C++ documentation for details.")
 809       .def(
 810           "create",
 811           [](py::str name, Host* h, py::object fun, py::args args) {
 812             fun.inc_ref();  // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
 813             args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
 814             return simgrid::s4u::Actor::create(name, h, [fun, args]() {
 815               py::gil_scoped_acquire py_context;
 816               try {
 817                 fun(*args);
 818               } catch (const py::error_already_set& ex) {
 819                 if (ex.matches(pyForcefulKillEx)) {
 820                   XBT_VERB("Actor killed");
 821                   simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
 822                 }
 823                 throw;
 824               }
 825             });
 826           },
 827           py::call_guard<py::gil_scoped_release>(),
 828           "Create an actor from a function or an object. See the :ref:`example <s4u_ex_actors_create>`.")
 829       .def_property(
 830           "host", &Actor::get_host,
 831           [](Actor* a, Host* h) {
 832             py::gil_scoped_release gil_guard;
 833             a->set_host(h);
 834           },
 835           "The host on which this actor is located. Changing this value migrates the actor.\n\n"
 836           "If the actor is currently blocked on an execution activity, the activity is also migrated to the new host. "
 837           "If it’s blocked on another kind of activity, an error is raised as the mandated code is not written yet. "
 838           "Please report that bug if you need it.\n\n"
 839           "Asynchronous activities started by the actor are not migrated automatically, so you have to take care of "
 840           "this yourself (only you knows which ones should be migrated). ")
 841       .def_property_readonly("name", &Actor::get_cname, "The name of this actor (read-only property).")
 842       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).")
 843       .def_property_readonly("ppid", &Actor::get_ppid,
 844                              "The PID (unique identifier) of the actor that created this one (read-only property).")
 845       .def_static("by_pid", &Actor::by_pid, py::arg("pid"), "Retrieve an actor by its PID")
 846       .def("set_auto_restart", &Actor::set_auto_restart, py::call_guard<py::gil_scoped_release>(),
 847            "Specify whether the actor shall restart when its host reboots.")
 848       .def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
 849            "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
 850            "documentation).")
 851       .def("is_daemon", &Actor::is_daemon,
 852            "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
 853            "terminates.")
 854       .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
 855            "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout") = -1)
 856       .def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
 857       .def("self", &Actor::self, "Retrieves the current actor.")
 858       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
 859       .def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
 860            "Suspend that actor, that is blocked until resume()ed by another actor.")
 861       .def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
 862            "Resume that actor, that was previously suspend()ed.")
 863       .def_static("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "Kill all actors but the caller.");
 864 }