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