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