src/bindings/python/simgrid_python.cpp

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