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