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