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