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