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