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