src/bindings/python/simgrid_python.cpp

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