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