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            [](simgrid::s4u::NetZone* self, simgrid::kernel::routing::NetPoint* src,
 240               simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
 241               simgrid::kernel::routing::NetPoint* gw_dst, const std::vector<simgrid::s4u::LinkInRoute>& links,
 242               bool symmetrical) {
 243              PyErr_WarnEx(PyExc_DeprecationWarning, // XBT_ATTRIB_DEPRECATED_v335. Once removed, uncomment the
 244                                                     // deprecation of the AddRoute function in C++
 245                           "Please call add_route either from Host to Host or NetZone to NetZone. This call will be "
 246                           "removed after SimGrid v3.35.",
 247                           1);
 248              self->add_route(src, dst, gw_src, gw_dst, links, symmetrical);
 249            })
 250       .def("add_route",
 251            py::overload_cast<const simgrid::s4u::Host*, const simgrid::s4u::Host*,
 252                              const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
 253            "Add a route between 2 hosts")
 254       .def("add_route",
 255            py::overload_cast<const simgrid::s4u::Host*, const simgrid::s4u::Host*,
 256                              const std::vector<const simgrid::s4u::Link*>&>(&simgrid::s4u::NetZone::add_route),
 257            "Add a route between 2 hosts")
 258       .def("add_route",
 259            py::overload_cast<const simgrid::s4u::NetZone*, const simgrid::s4u::NetZone*,
 260                              const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
 261            "Add a route between 2 netzones. The gateway of each zone gets used.")
 262       .def("add_route",
 263            py::overload_cast<const simgrid::s4u::NetZone*, const simgrid::s4u::NetZone*,
 264                              const std::vector<const simgrid::s4u::Link*>&>(&simgrid::s4u::NetZone::add_route),
 265            "Add a route between 2 netzones. The gateway of each zone gets used.")
 266       .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
 267            "Creates a host")
 268       .def("create_host",
 269            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
 270            "Creates a host")
 271       .def("create_host",
 272            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
 273            "Creates a host")
 274       .def("create_host",
 275            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
 276            "Creates a host")
 277       .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
 278            "Creates a network link")
 279       .def("create_link",
 280            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
 281            "Creates a network link")
 282       .def("create_link",
 283            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
 284            "Creates a network link")
 285       .def("create_link",
 286            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
 287            "Creates a network link")
 288       .def("create_split_duplex_link",
 289            py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
 290            "Creates a split-duplex link")
 291       .def("create_split_duplex_link",
 292            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
 293            "Creates a split-duplex link")
 294       .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
 295       .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
 296       .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
 297       .def("set_gateway", py::overload_cast<simgrid::s4u::Host*>(&simgrid::s4u::NetZone::set_gateway),
 298            "Specify the gateway of this zone, to be used for inter-zone routes")
 299       .def("set_gateway", py::overload_cast<simgrid::kernel::routing::NetPoint*>(&simgrid::s4u::NetZone::set_gateway),
 300            "Specify the gateway of this zone, to be used for inter-zone routes")
 301       .def_property_readonly("netpoint", &simgrid::s4u::NetZone::get_netpoint,
 302                              "Retrieve the netpoint associated to this zone")
 303       .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
 304       .def_property_readonly("name", &simgrid::s4u::NetZone::get_name,
 305                              "The name of this network zone (read-only property).")
 306       .def(
 307           "__repr__", [](const simgrid::s4u::NetZone net) { return "NetZone(" + net.get_name() + ")"; },
 308           "Textual representation of the NetZone");
 309
 310   /* Class ClusterCallbacks */
 311   py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
 312       .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
 313                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
 314                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
 315
 316   /* Class FatTreeParams */
 317   py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
 318       .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
 319                     const std::vector<unsigned int>&>());
 320
 321   /* Class DragonflyParams */
 322   py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
 323       .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
 324                     const std::pair<unsigned int, unsigned int>&, unsigned int>());
 325
 326   /* Class Host */
 327   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
 328       m, "Host", "Simulated host. See the C++ documentation for details.");
 329   host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die")
 330       .def(
 331           "route_to",
 332           [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
 333             auto* list = new std::vector<Link*>();
 334             double bw  = 0;
 335             h->route_to(to, *list, &bw);
 336             return make_tuple(list, bw);
 337           },
 338           "Retrieves the list of links and the bandwidth between two hosts.")
 339       .def(
 340           "set_speed_profile",
 341           [](Host* h, const std::string& profile, double period) {
 342             h->set_speed_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 343           },
 344           py::call_guard<py::gil_scoped_release>(),
 345           "Specify a profile modeling the external load according to an exhaustive list. "
 346           "Each line of the profile describes timed events as ``date ratio``. "
 347           "For example, the following content describes an host which computational speed is initially 1 (i.e, 100%) "
 348           "and then halved after 42 seconds:\n\n"
 349           ".. code-block:: python\n\n"
 350           "   \"\"\"\n"
 351           "   0 1.0\n"
 352           "   42 0.5\n"
 353           "   \"\"\"\n\n"
 354           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 355           " while speed profiles of hosts contain ratios.\n\n"
 356           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 357           "the list. Set it to -1 to not loop over.")
 358       .def(
 359           "set_state_profile",
 360           [](Host* h, const std::string& profile, double period) {
 361             h->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 362           },
 363           py::call_guard<py::gil_scoped_release>(),
 364           "Specify a profile modeling the churn. "
 365           "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
 366           "whether the host is on. "
 367           "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
 368           ".. code-block:: python\n\n"
 369           "   \"\"\"\n"
 370           "   1.0 0\n"
 371           "   2.0 1\n"
 372           "   \"\"\"\n\n"
 373           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 374           "the list. Set it to -1 to not loop over.")
 375       .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
 376       .def("pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
 377       .def_property_readonly("netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this zone")
 378       .def_property_readonly("disks", &Host::get_disks, "The list of disks on this host (read-only).")
 379       .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
 380       .def_property("core_count", &Host::get_core_count,
 381                     py::cpp_function(&Host::set_core_count, py::call_guard<py::gil_scoped_release>()),
 382                     "Manage the number of cores in the CPU")
 383       .def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
 384            "Set the coordinates of this host")
 385       .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 386            "Describe how the CPU is shared", py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 387       .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk),
 388            py::call_guard<py::gil_scoped_release>(), "Create a disk")
 389       .def("create_disk",
 390            py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
 391            py::call_guard<py::gil_scoped_release>(), "Create a disk")
 392       .def("seal", &Host::seal, py::call_guard<py::gil_scoped_release>(), "Seal this host")
 393       .def("turn_off", &Host::turn_off, py::call_guard<py::gil_scoped_release>(), "Turn off this host")
 394       .def("turn_on", &Host::turn_on, py::call_guard<py::gil_scoped_release>(), "Turn on this host")
 395       .def_property("pstate", &Host::get_pstate,
 396                     py::cpp_function(&Host::set_pstate, py::call_guard<py::gil_scoped_release>()),
 397                     "The current pstate (read/write property).")
 398       .def_static("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
 399                   "Retrieves the host on which the running actor is located.")
 400       .def_property_readonly("name", &Host::get_name, "The name of this host (read-only property).")
 401       .def_property_readonly("load", &Host::get_load,
 402                              "Returns the current computation load (in flops per second), NOT taking the external load "
 403                              "into account. This is the currently achieved speed (read-only property).")
 404       .def_property_readonly(
 405           "speed", &Host::get_speed,
 406           "The peak computing speed in flops/s at the current pstate, NOT taking the external load into account. "
 407           "This is the max potential speed (read-only property).")
 408       .def_property_readonly("available_speed", &Host::get_available_speed,
 409                              "Get the available speed ratio, between 0 and 1.\n"
 410                              "This accounts for external load (see :py:func:`set_speed_profile() "
 411                              "<simgrid.Host.set_speed_profile>`) (read-only property).")
 412       .def_static(
 413           "on_creation_cb",
 414           [](py::object cb) {
 415             cb.inc_ref(); // keep alive after return
 416             const py::gil_scoped_release gil_release;
 417             Host::on_creation_cb([cb_p = cb.ptr()](Host& h) {
 418               const py::gil_scoped_acquire py_context; // need a new context for callback
 419               try {
 420                 const auto fun = py::reinterpret_borrow<py::function>(cb_p);
 421                 fun(&h);
 422               } catch (const py::error_already_set& e) {
 423                 xbt_die("Error while executing the on_creation lambda : %s", e.what());
 424               }
 425             });
 426           },
 427           "")
 428       .def(
 429           "__repr__", [](const Host* h) { return "Host(" + h->get_name() + ")"; },
 430           "Textual representation of the Host.");
 431
 432   m.def("sg_host_load_plugin_init", [host]() {
 433     sg_host_load_plugin_init();
 434
 435     static_cast<pybind11::class_<simgrid::s4u::Host, std::unique_ptr<simgrid::s4u::Host, pybind11::nodelete>>>(host)
 436         .def(
 437             "reset_load", [](const Host* h) { sg_host_load_reset(h); }, py::call_guard<py::gil_scoped_release>(),
 438             "Reset counters of the host load plugin for this host.")
 439         .def_property_readonly(
 440             "current_load", [](const Host* h) { return sg_host_get_current_load(h); }, "Current load of the host.")
 441         .def_property_readonly(
 442             "avg_load", [](const Host* h) { return sg_host_get_avg_load(h); }, "Average load of the host.")
 443         .def_property_readonly(
 444             "idle_time", [](const Host* h) { return sg_host_get_idle_time(h); }, "Idle time of the host")
 445         .def_property_readonly(
 446             "total_idle_time", [](const Host* h) { return sg_host_get_total_idle_time(h); },
 447             "Total idle time of the host.")
 448         .def_property_readonly(
 449             "computed_flops", [](const Host* h) { return sg_host_get_computed_flops(h); },
 450             "Computed flops of the host.");
 451   });
 452
 453   py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
 454       .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
 455       .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR);
 456
 457   /* Class Disk */
 458   py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(
 459       m, "Disk", "Simulated disk. See the C++ documentation for details.");
 460   disk.def("read", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::read, py::const_),
 461            py::call_guard<py::gil_scoped_release>(), "Read data from disk", py::arg("size"), py::arg("priority") = 1)
 462       .def("write", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::write, py::const_),
 463            py::call_guard<py::gil_scoped_release>(), "Write data in disk", py::arg("size"), py::arg("priority") = 1)
 464       .def("read_async", &simgrid::s4u::Disk::read_async, py::call_guard<py::gil_scoped_release>(),
 465            "Non-blocking read data from disk")
 466       .def("write_async", &simgrid::s4u::Disk::write_async, py::call_guard<py::gil_scoped_release>(),
 467            "Non-blocking write data in disk")
 468       .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 469            "Set sharing policy for this disk", py::arg("op"), py::arg("policy"),
 470            py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 471       .def("seal", &simgrid::s4u::Disk::seal, py::call_guard<py::gil_scoped_release>(), "Seal this disk")
 472       .def_property_readonly("name", &simgrid::s4u::Disk::get_name, "The name of this disk (read-only property).")
 473       .def(
 474           "__repr__", [](const Disk* d) { return "Disk(" + d->get_name() + ")"; },
 475           "Textual representation of the Disk");
 476   py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
 477       .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
 478       .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR);
 479   py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
 480       .value("READ", simgrid::s4u::Disk::Operation::READ)
 481       .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
 482       .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE);
 483
 484   /* Class NetPoint */
 485   py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
 486       netpoint(m, "NetPoint", "NetPoint object");
 487
 488   /* Class Link */
 489   py::class_<Link, std::unique_ptr<Link, py::nodelete>> link(m, "Link",
 490                                                              "Network link. See the C++ documentation for details.");
 491   link.def("set_latency", py::overload_cast<const std::string&>(&Link::set_latency),
 492            py::call_guard<py::gil_scoped_release>(),
 493            "Set the latency as a string. Accepts values with units, such as ‘1s’ or ‘7ms’.\nFull list of accepted "
 494            "units: w (week), d (day), h, s, ms, us, ns, ps.")
 495       .def("set_latency", py::overload_cast<double>(&Link::set_latency), py::call_guard<py::gil_scoped_release>(),
 496            "Set the latency as a float (in seconds).")
 497       .def("set_bandwidth", &Link::set_bandwidth, py::call_guard<py::gil_scoped_release>(),
 498            "Set the bandwidth (in byte per second).")
 499       .def(
 500           "set_bandwidth_profile",
 501           [](Link* l, const std::string& profile, double period) {
 502             l->set_bandwidth_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 503           },
 504           py::call_guard<py::gil_scoped_release>(),
 505           "Specify a profile modeling the external load according to an exhaustive list. "
 506           "Each line of the profile describes timed events as ``date bandwidth`` (in bytes per second). "
 507           "For example, the following content describes a link which bandwidth changes to 40 Mb/s at t=4, and to 6 "
 508           "Mb/s at t=8:\n\n"
 509           ".. code-block:: python\n\n"
 510           "   \"\"\"\n"
 511           "   4.0 40000000\n"
 512           "   8.0 60000000\n"
 513           "   \"\"\"\n\n"
 514           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 515           " while speed profiles of hosts contain ratios.\n\n"
 516           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 517           "the list. Set it to -1 to not loop over.")
 518       .def(
 519           "set_latency_profile",
 520           [](Link* l, const std::string& profile, double period) {
 521             l->set_latency_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 522           },
 523           py::call_guard<py::gil_scoped_release>(),
 524           "Specify a profile modeling the external load according to an exhaustive list. "
 525           "Each line of the profile describes timed events as ``date latency`` (in seconds). "
 526           "For example, the following content describes a link which latency changes to 1ms (0.001s) at t=1, and to 2s "
 527           "at t=2:\n\n"
 528           ".. code-block:: python\n\n"
 529           "   \"\"\"\n"
 530           "   1.0 0.001\n"
 531           "   2.0 2\n"
 532           "   \"\"\"\n\n"
 533           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 534           " while speed profiles of hosts contain ratios.\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       .def(
 538           "set_state_profile",
 539           [](Link* l, const std::string& profile, double period) {
 540             l->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 541           },
 542           "Specify a profile modeling the churn. "
 543           "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
 544           "whether the link is on. "
 545           "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
 546           ".. code-block:: python\n\n"
 547           "   \"\"\"\n"
 548           "   1.0 0\n"
 549           "   2.0 1\n"
 550           "   \"\"\"\n\n"
 551           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 552           "the list. Set it to -1 to not loop over.")
 553
 554       .def("turn_on", &Link::turn_on, py::call_guard<py::gil_scoped_release>(), "Turns the link on.")
 555       .def("turn_off", &Link::turn_off, py::call_guard<py::gil_scoped_release>(), "Turns the link off.")
 556       .def("is_on", &Link::is_on, "Check whether the link is on.")
 557
 558       .def("set_sharing_policy", &Link::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 559            "Set sharing policy for this link")
 560       .def("set_concurrency_limit", &Link::set_concurrency_limit, py::call_guard<py::gil_scoped_release>(),
 561            "Set concurrency limit for this link")
 562       .def("set_host_wifi_rate", &Link::set_host_wifi_rate, py::call_guard<py::gil_scoped_release>(),
 563            "Set level of communication speed of given host on this Wi-Fi link")
 564       .def_static("by_name", &Link::by_name, "Retrieves a Link from its name, or dies")
 565       .def("seal", &Link::seal, py::call_guard<py::gil_scoped_release>(), "Seal this link")
 566       .def_property_readonly("name", &Link::get_name, "The name of this link")
 567       .def_property_readonly("bandwidth", &Link::get_bandwidth,
 568                              "The bandwidth (in bytes per second) (read-only property).")
 569       .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property).")
 570       .def(
 571           "__repr__", [](const Link* l) { return "Link(" + l->get_name() + ")"; },
 572           "Textual representation of the Link");
 573   py::enum_<Link::SharingPolicy>(link, "SharingPolicy")
 574       .value("NONLINEAR", Link::SharingPolicy::NONLINEAR,
 575              "This policy takes a callback that specifies the maximal capacity as a function of the number of usage. "
 576              "See the examples with 'degradation' in their name.")
 577       .value("WIFI", Link::SharingPolicy::WIFI, "Pseudo-sharing policy requesting wifi-specific sharing.")
 578       .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX,
 579              "Each link is split in 2, UP and DOWN, one per direction. These links are SHARED.")
 580       .value("SHARED", Link::SharingPolicy::SHARED,
 581              "The bandwidth is shared between all comms using that link, regardless of their direction.")
 582       .value("FATPIPE", Link::SharingPolicy::FATPIPE,
 583              "Each comm can use the link fully, with no sharing (only a maximum). This is intended to represent the "
 584              "backbone links that cannot be saturated by concurrent links, but have a maximal bandwidth.");
 585
 586   /* Class LinkInRoute */
 587   py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
 588   linkinroute.def(py::init<const Link*>());
 589   linkinroute.def(py::init<const Link*, simgrid::s4u::LinkInRoute::Direction>());
 590   py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
 591       .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
 592       .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
 593       .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE);
 594
 595   /* Class Split-Duplex Link */
 596   py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
 597       m, "SplitDuplexLink", "Network split-duplex link")
 598       .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
 599       .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
 600
 601   /* Class Mailbox */
 602   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
 603       m, "Mailbox", "Mailbox. See the C++ documentation for details.")
 604       .def(
 605           "__repr__", [](const Mailbox* self) { return "Mailbox(" + self->get_name() + ")"; },
 606           "Textual representation of the Mailbox")
 607       .def_static("by_name", &Mailbox::by_name, py::call_guard<py::gil_scoped_release>(), py::arg("name"),
 608                   "Retrieve a Mailbox from its name")
 609       .def_property_readonly("name", &Mailbox::get_name, "The name of that mailbox (read-only property).")
 610       .def_property_readonly("ready", &Mailbox::ready,
 611                              "Check if there is a communication ready to be consumed from a mailbox.")
 612       .def(
 613           "put",
 614           [](Mailbox* self, py::object data, uint64_t size, double timeout) {
 615             auto* data_ptr = data.inc_ref().ptr();
 616             const py::gil_scoped_release gil_release;
 617             self->put(data_ptr, size, timeout);
 618           },
 619           "Blocking data transmission with a timeout")
 620       .def(
 621           "put",
 622           [](Mailbox* self, py::object data, uint64_t size) {
 623             auto* data_ptr = data.inc_ref().ptr();
 624             const py::gil_scoped_release gil_release;
 625             self->put(data_ptr, size);
 626           },
 627           "Blocking data transmission")
 628       .def(
 629           "put_async",
 630           [](Mailbox* self, py::object data, uint64_t size) {
 631             auto* data_ptr = data.inc_ref().ptr();
 632             const py::gil_scoped_release gil_release;
 633             return self->put_async(data_ptr, size);
 634           },
 635           "Non-blocking data transmission")
 636       .def(
 637           "put_init",
 638           [](Mailbox* self, py::object data, uint64_t size) {
 639             auto* data_ptr = data.inc_ref().ptr();
 640             const py::gil_scoped_release gil_release;
 641             return self->put_init(data_ptr, size);
 642           },
 643           "Creates (but don’t start) a data transmission to that mailbox.")
 644       .def(
 645           "get", [](Mailbox* self) { return py::reinterpret_steal<py::object>(self->get<PyObject>()); },
 646           py::call_guard<py::gil_scoped_release>(), "Blocking data reception")
 647       .def(
 648           "get_async", [](Mailbox* self) -> CommPtr { return self->get_async(); },
 649           py::call_guard<py::gil_scoped_release>(),
 650           "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
 651       .def("set_receiver", &Mailbox::set_receiver, py::call_guard<py::gil_scoped_release>(),
 652            "Sets the actor as permanent receiver");
 653
 654   /* class Activity */
 655   py::class_<Activity, ActivityPtr>(m, "Activity", "Activity. See the C++ documentation for details.");
 656
 657   /* Class Comm */
 658   py::class_<Comm, CommPtr, Activity>(m, "Comm", "Communication. See the C++ documentation for details.")
 659       .def_property_readonly("dst_data_size", &Comm::get_dst_data_size, py::call_guard<py::gil_scoped_release>(),
 660                              "Retrieve the size of the received data.")
 661       .def_property_readonly("mailbox", &Comm::get_mailbox, py::call_guard<py::gil_scoped_release>(),
 662                              "Retrieve the mailbox on which this comm acts.")
 663       .def_property_readonly("sender", &Comm::get_sender, py::call_guard<py::gil_scoped_release>())
 664       .def_property_readonly("state_str", &Comm::get_state_str, py::call_guard<py::gil_scoped_release>(),
 665                              "Retrieve the Comm state as string")
 666       .def_property_readonly("remaining", &Comm::get_remaining, py::call_guard<py::gil_scoped_release>(),
 667                              "Remaining amount of work that this Comm entails")
 668       .def_property_readonly("start_time", &Comm::get_start_time, py::call_guard<py::gil_scoped_release>(),
 669                              "Time at which this Comm started")
 670       .def_property_readonly("finish_time", &Comm::get_finish_time, py::call_guard<py::gil_scoped_release>(),
 671                              "Time at which this Comm finished")
 672       .def_property_readonly("is_suspended", &Comm::is_suspended, py::call_guard<py::gil_scoped_release>(),
 673                              "Whether this Comm is suspended")
 674       .def("set_payload_size", &Comm::set_payload_size, py::call_guard<py::gil_scoped_release>(), py::arg("bytes"),
 675            "Specify the amount of bytes which exchange should be simulated.")
 676       .def("set_rate", &Comm::set_rate, py::call_guard<py::gil_scoped_release>(), py::arg("rate"),
 677            "Sets the maximal communication rate (in byte/sec). Must be done before start")
 678       .def("cancel", &Comm::cancel, py::call_guard<py::gil_scoped_release>(),
 679            py::return_value_policy::reference_internal, "Cancel the activity.")
 680       .def("start", &Comm::start, py::call_guard<py::gil_scoped_release>(), py::return_value_policy::reference_internal,
 681            "Starts a previously created activity. This function is optional: you can call wait() even if you didn't "
 682            "call start()")
 683       .def("suspend", &Comm::suspend, py::call_guard<py::gil_scoped_release>(),
 684            py::return_value_policy::reference_internal, "Suspend the activity.")
 685       .def("resume", &Comm::resume, py::call_guard<py::gil_scoped_release>(),
 686            py::return_value_policy::reference_internal, "Resume the activity.")
 687       .def("test", &Comm::test, py::call_guard<py::gil_scoped_release>(),
 688            "Test whether the communication is terminated.")
 689       .def("wait", &Comm::wait, py::call_guard<py::gil_scoped_release>(),
 690            "Block until the completion of that communication.")
 691       .def("wait_for", &Comm::wait_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
 692            "Block until the completion of that communication, or raises TimeoutException after the specified timeout.")
 693       .def("wait_until", &Comm::wait_until, py::call_guard<py::gil_scoped_release>(), py::arg("time_limit"),
 694            "Block until the completion of that communication, or raises TimeoutException after the specified time.")
 695       .def(
 696           "get_payload",
 697           [](const Comm* self) { return py::reinterpret_steal<py::object>((PyObject*)self->get_payload()); },
 698           py::call_guard<py::gil_scoped_release>(),
 699           "Retrieve the message's payload of a get_async. You cannot call this until after the comm termination.")
 700       .def("detach", py::overload_cast<>(&Comm::detach), py::return_value_policy::reference_internal,
 701            py::call_guard<py::gil_scoped_release>(),
 702            "Start the comm, and ignore its result. It can be completely forgotten after that.")
 703       .def_static("sendto", &Comm::sendto, py::call_guard<py::gil_scoped_release>(), py::arg("from"), py::arg("to"),
 704                   py::arg("simulated_size_in_bytes"), "Do a blocking communication between two arbitrary hosts.")
 705       .def_static("sendto_init", py::overload_cast<Host*, Host*>(&Comm::sendto_init),
 706                   py::call_guard<py::gil_scoped_release>(), py::arg("from"), py::arg("to"),
 707                   "Creates a communication between the two given hosts, bypassing the mailbox mechanism.")
 708       .def_static("sendto_async", &Comm::sendto_async, py::call_guard<py::gil_scoped_release>(), py::arg("from"),
 709                   py::arg("to"), py::arg("simulated_size_in_bytes"),
 710                   "Do a blocking communication between two arbitrary hosts.\n\nThis initializes a communication that "
 711                   "completely bypass the mailbox and actors mechanism. There is really no limit on the hosts involved. "
 712                   "In particular, the actor does not have to be on one of the involved hosts.");
 713
 714   /* Class Io */
 715   py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr, Activity>(m, "Io",
 716                                                               "I/O activities. See the C++ documentation for details.")
 717       .def("test", &simgrid::s4u::Io::test, py::call_guard<py::gil_scoped_release>(),
 718            "Test whether the I/O is terminated.")
 719       .def("wait", &simgrid::s4u::Io::wait, py::call_guard<py::gil_scoped_release>(),
 720            "Block until the completion of that I/O operation");
 721
 722   /* Class Exec */
 723   py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr, Activity>(m, "Exec",
 724                                                                   "Execution. See the C++ documentation for details.")
 725       .def_property_readonly("remaining", &simgrid::s4u::Exec::get_remaining, py::call_guard<py::gil_scoped_release>(),
 726                              "Amount of flops that remain to be computed until completion (read-only property).")
 727       .def_property_readonly("remaining_ratio", &simgrid::s4u::Exec::get_remaining_ratio,
 728                              py::call_guard<py::gil_scoped_release>(),
 729                              "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
 730                              "yet) (read-only property).")
 731       .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
 732                     "Host on which this execution runs. Only the first host is returned for parallel executions. "
 733                     "Changing this value migrates the execution.")
 734       .def_property_readonly("is_suspended", &simgrid::s4u::Exec::is_suspended,
 735                              py::call_guard<py::gil_scoped_release>(), "Whether this Exec is suspended")
 736       .def("test", &simgrid::s4u::Exec::test, py::call_guard<py::gil_scoped_release>(),
 737            "Test whether the execution is terminated.")
 738       .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<py::gil_scoped_release>(), "Cancel that execution.")
 739       .def("start", &simgrid::s4u::Exec::start, py::call_guard<py::gil_scoped_release>(), "Start that execution.")
 740       .def("suspend", &simgrid::s4u::Exec::suspend, py::call_guard<py::gil_scoped_release>(), "Suspend that execution.")
 741       .def("resume", &simgrid::s4u::Exec::resume, py::call_guard<py::gil_scoped_release>(), "Resume that execution.")
 742       .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<py::gil_scoped_release>(),
 743            "Block until the completion of that execution.")
 744       .def("wait_for", &simgrid::s4u::Exec::wait_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
 745            "Block until the completion of that activity, or raises TimeoutException after the specified timeout.");
 746
 747   /* Class Semaphore */
 748   py::class_<Semaphore, SemaphorePtr>(m, "Semaphore",
 749                                       "A classical semaphore, but blocking in the simulation world. See the C++ "
 750                                       "documentation for details.")
 751       .def(py::init<>(&Semaphore::create), py::call_guard<py::gil_scoped_release>(), py::arg("capacity"),
 752            "Semaphore constructor.")
 753       .def("acquire", &Semaphore::acquire, py::call_guard<py::gil_scoped_release>(),
 754            "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired.")
 755       .def("acquire_timeout", &Semaphore::acquire_timeout, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
 756            "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired or return "
 757            "true if it has not been acquired after the specified timeout.")
 758       .def("release", &Semaphore::release, py::call_guard<py::gil_scoped_release>(), "Release the semaphore.")
 759       .def_property_readonly("capacity", &Semaphore::get_capacity, py::call_guard<py::gil_scoped_release>(),
 760                              "Get the semaphore capacity.")
 761       .def_property_readonly("would_block", &Semaphore::would_block, py::call_guard<py::gil_scoped_release>(),
 762                              "Check whether trying to acquire the semaphore would block (in other word, checks whether "
 763                              "this semaphore has capacity).")
 764       // Allow semaphores to be automatically acquired/released with a context manager: `with semaphore: ...`
 765       .def("__enter__", &Semaphore::acquire, py::call_guard<py::gil_scoped_release>())
 766       .def("__exit__",
 767            [](Semaphore* self, const py::object&, const py::object&, const py::object&) { self->release(); });
 768
 769   /* Class Mutex */
 770   py::class_<Mutex, MutexPtr>(m, "Mutex",
 771                               "A classical mutex, but blocking in the simulation world."
 772                               "See the C++ documentation for details.")
 773       .def(py::init<>(&Mutex::create), py::call_guard<py::gil_scoped_release>(),
 774            "Mutex constructor (pass True as a parameter to get a recursive Mutex).", py::arg("recursive") = false)
 775       .def("lock", &Mutex::lock, py::call_guard<py::gil_scoped_release>(), "Block until the mutex is acquired.")
 776       .def("try_lock", &Mutex::try_lock, py::call_guard<py::gil_scoped_release>(),
 777            "Try to acquire the mutex. Return true if the mutex was acquired, false otherwise.")
 778       .def("unlock", &Mutex::unlock, py::call_guard<py::gil_scoped_release>(), "Release the mutex.")
 779       // Allow mutexes to be automatically acquired/released with a context manager: `with mutex: ...`
 780       .def("__enter__", &Mutex::lock, py::call_guard<py::gil_scoped_release>())
 781       .def(
 782           "__exit__", [](Mutex* self, const py::object&, const py::object&, const py::object&) { self->unlock(); },
 783           py::call_guard<py::gil_scoped_release>());
 784
 785   /* Class Barrier */
 786   py::class_<Barrier, BarrierPtr>(m, "Barrier", "A classical barrier, but blocking in the simulation world.")
 787       .def(py::init<>(&Barrier::create), py::call_guard<py::gil_scoped_release>(), py::arg("expected_actors"),
 788            "Barrier constructor.")
 789       .def("wait", &Barrier::wait, py::call_guard<py::gil_scoped_release>(),
 790            "Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches "
 791            "the barrier.");
 792
 793   /* Class Actor */
 794   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 795                                             "An actor is an independent stream of execution in your distributed "
 796                                             "application. See the C++ documentation for details.")
 797       .def(
 798           "create",
 799           [](const std::string& name, Host* h, py::object fun, py::args args) {
 800             fun.inc_ref();  // keep alive after return
 801             args.inc_ref(); // keep alive after return
 802             const py::gil_scoped_release gil_release;
 803             return simgrid::s4u::Actor::create(name, h, [fun_p = fun.ptr(), args_p = args.ptr()]() {
 804               const py::gil_scoped_acquire py_context;
 805               try {
 806                 const auto fun  = py::reinterpret_borrow<py::object>(fun_p);
 807                 const auto args = py::reinterpret_borrow<py::args>(args_p);
 808                 fun(*args);
 809               } catch (const py::error_already_set& ex) {
 810                 if (ex.matches(pyForcefulKillEx)) {
 811                   XBT_VERB("Actor killed");
 812                   simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
 813                 }
 814                 throw;
 815               }
 816             });
 817           },
 818           "Create an actor from a function or an object. See the :ref:`example <s4u_ex_actors_create>`.")
 819       .def_property(
 820           "host", &Actor::get_host, py::cpp_function(&Actor::set_host, py::call_guard<py::gil_scoped_release>()),
 821           "The host on which this actor is located. Changing this value migrates the actor.\n\n"
 822           "If the actor is currently blocked on an execution activity, the activity is also migrated to the new host. "
 823           "If it’s blocked on another kind of activity, an error is raised as the mandated code is not written yet. "
 824           "Please report that bug if you need it.\n\n"
 825           "Asynchronous activities started by the actor are not migrated automatically, so you have to take care of "
 826           "this yourself (only you knows which ones should be migrated). ")
 827       .def_property_readonly("name", &Actor::get_cname, "The name of this actor (read-only property).")
 828       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).")
 829       .def_property_readonly("ppid", &Actor::get_ppid,
 830                              "The PID (unique identifier) of the actor that created this one (read-only property).")
 831       .def_static("by_pid", &Actor::by_pid, py::arg("pid"), "Retrieve an actor by its PID")
 832       .def("set_auto_restart", &Actor::set_auto_restart, py::call_guard<py::gil_scoped_release>(),
 833            "Specify whether the actor shall restart when its host reboots.")
 834       .def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
 835            "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
 836            "documentation).")
 837       .def("is_daemon", &Actor::is_daemon,
 838            "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
 839            "terminates.")
 840       .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
 841            "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout") = -1)
 842       .def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
 843       .def("self", &Actor::self, "Retrieves the current actor.")
 844       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
 845       .def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
 846            "Suspend that actor, that is blocked until resume()ed by another actor.")
 847       .def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
 848            "Resume that actor, that was previously suspend()ed.")
 849       .def_static("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(),
 850                   "Kill all actors but the caller.")
 851       .def(
 852           "__repr__", [](const ActorPtr a) { return "Actor(" + a->get_name() + ")"; },
 853           "Textual representation of the Actor");
 854
 855   /* Enum Class IoOpType */
 856   py::enum_<simgrid::s4u::Io::OpType>(m, "IoOpType")
 857       .value("READ", simgrid::s4u::Io::OpType::READ)
 858       .value("WRITE", simgrid::s4u::Io::OpType::WRITE);
 859
 860   /* Class Task */
 861   py::class_<Task, TaskPtr>(m, "Task", "Task. See the C++ documentation for details.")
 862       .def_static(
 863           "on_start_cb",
 864           [](py::object cb) {
 865             cb.inc_ref(); // keep alive after return
 866             const py::gil_scoped_release gil_release;
 867             Task::on_start_cb([cb_p = cb.ptr()](Task* op) {
 868               const py::gil_scoped_acquire py_context; // need a new context for callback
 869               py::reinterpret_borrow<py::function>(cb_p)(op);
 870             });
 871           },
 872           "Add a callback called when each task starts.")
 873       .def_static(
 874           "on_completion_cb",
 875           [](py::object cb) {
 876             cb.inc_ref(); // keep alive after return
 877             const py::gil_scoped_release gil_release;
 878             Task::on_completion_cb([cb_p = cb.ptr()](Task* op) {
 879               const py::gil_scoped_acquire py_context; // need a new context for callback
 880               py::reinterpret_borrow<py::function>(cb_p)(op);
 881             });
 882           },
 883           "Add a callback called when each task ends.")
 884       .def_property_readonly("name", &Task::get_name, "The name of this task (read-only).")
 885       .def_property_readonly("successors", &Task::get_successors, "The successors of this task (read-only).")
 886       .def_property("amount", &Task::get_amount, &Task::set_amount, "The amount of work to do for this task.")
 887       .def(
 888           "get_count", [](const TaskPtr t) { return t->get_count("instance_0"); },
 889           "The execution count of this task instance_0.")
 890       .def(
 891           "get_count", [](const TaskPtr t, const std::string& instance) { return t->get_count(instance); },
 892           "The execution count of this task instance.")
 893       .def("enqueue_firings", py::overload_cast<int>(&Task::enqueue_firings), py::call_guard<py::gil_scoped_release>(),
 894            py::arg("n"), "Enqueue firings for this task.")
 895       .def("add_successor", py::overload_cast<TaskPtr>(&Task::add_successor), py::call_guard<py::gil_scoped_release>(),
 896            py::arg("op"), "Add a successor to this task.")
 897       .def("remove_successor", py::overload_cast<TaskPtr>(&Task::remove_successor),
 898            py::call_guard<py::gil_scoped_release>(), py::arg("op"), "Remove a successor of this task.")
 899       .def("remove_all_successors", &Task::remove_all_successors, py::call_guard<py::gil_scoped_release>(),
 900            "Remove all successors of this task.")
 901       .def("on_this_start_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_start_cb),
 902            py::arg("func"), "Add a callback called when this task starts.")
 903       .def("on_this_completion_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_completion_cb),
 904            py::arg("func"), "Add a callback called when this task ends.")
 905       .def(
 906           "__repr__", [](const TaskPtr op) { return "Task(" + op->get_name() + ")"; },
 907           "Textual representation of the Task");
 908
 909   /* Class CommTask */
 910   py::class_<CommTask, CommTaskPtr, Task>(m, "CommTask", "Communication Task. See the C++ documentation for details.")
 911       .def_static("init", py::overload_cast<const std::string&>(&CommTask::init),
 912                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), "CommTask constructor")
 913       .def_static("init", py::overload_cast<const std::string&, double, Host*, Host*>(&CommTask::init),
 914                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("source"),
 915                   py::arg("destination"), "CommTask constructor")
 916       .def_property("source", &CommTask::get_source, &CommTask::set_source, "The source of the communication.")
 917       .def_property("destination", &CommTask::get_destination, &CommTask::set_destination,
 918                     "The destination of the communication.")
 919       .def_property("bytes", &CommTask::get_bytes, &CommTask::set_bytes, "The amount of bytes to send.")
 920       .def(
 921           "__repr__", [](const CommTaskPtr c) { return "CommTask(" + c->get_name() + ")"; },
 922           "Textual representation of the CommTask");
 923
 924   /* Class ExecTask */
 925   py::class_<ExecTask, ExecTaskPtr, Task>(m, "ExecTask", "Execution Task. See the C++ documentation for details.")
 926       .def_static("init", py::overload_cast<const std::string&>(&ExecTask::init),
 927                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), "ExecTask constructor")
 928       .def_static("init", py::overload_cast<const std::string&, double, Host*>(&ExecTask::init),
 929                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("flops"), py::arg("host"),
 930                   "CommTask constructor.")
 931       .def_property("host", &ExecTask::get_host, &ExecTask::set_host, "The host of the execution.")
 932       .def_property("flops", &ExecTask::get_flops, &ExecTask::set_flops, "The amount of flops to execute.")
 933       .def(
 934           "__repr__", [](const ExecTaskPtr e) { return "ExecTask(" + e->get_name() + ")"; },
 935           "Textual representation of the ExecTask");
 936
 937   /* Class IoTask */
 938   py::class_<IoTask, IoTaskPtr, Task>(m, "IoTask", "IO Task. See the C++ documentation for details.")
 939       .def_static("init", py::overload_cast<const std::string&>(&IoTask::init),
 940                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), "IoTask constructor")
 941       .def_static("init", py::overload_cast<const std::string&, double, Disk*, Io::OpType>(&IoTask::init),
 942                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("disk"),
 943                   py::arg("type"), "IoTask constructor.")
 944       .def_property("disk", &IoTask::get_disk, &IoTask::set_disk, "The disk of the IO.")
 945       .def_property("bytes", &IoTask::get_bytes, &IoTask::set_bytes, "The amount of bytes to process.")
 946       .def_property("type", &IoTask::get_bytes, &IoTask::set_bytes, "The type of IO.")
 947       .def(
 948           "__repr__", [](const IoTaskPtr io) { return "IoTask(" + io->get_name() + ")"; },
 949           "Textual representation of the IoTask");
 950
 951   /* Class ActivitySet */
 952   py::class_<ActivitySet, ActivitySetPtr>(m, "ActivitySet", "ActivitySet. See the C++ documentation for details.")
 953       .def(py::init([](std::vector<simgrid::s4u::ActivityPtr> activities) {
 954              auto* ret = new ActivitySet();
 955              for (auto a : activities)
 956                ret->push(a);
 957              return ActivitySetPtr(ret);
 958            }),
 959            "The constructor should take the parameters from the command line, as is ")
 960       .def(py::init([]() { return ActivitySetPtr(new ActivitySet()); }),
 961            "The constructor should take the parameters from the command line, as is ")
 962
 963       .def("push", &ActivitySet::push, py::call_guard<py::gil_scoped_release>(), py::arg("activity"),
 964            "Add an activity to the set")
 965       .def("erase", &ActivitySet::erase, py::call_guard<py::gil_scoped_release>(), py::arg("activity"),
 966            "Remove that activity from the set")
 967       .def_property_readonly("size", &ActivitySet::size, "Count of activities in the set")
 968       .def("empty", &ActivitySet::empty, "Returns whether the set is empty")
 969       .def("has_failed_activities", &ActivitySet::has_failed_activities,
 970            "Returns whether there is any failed activities")
 971       .def("get_failed_activity", &ActivitySet::get_failed_activity, "Returns a failed activity from the set, or None")
 972
 973       .def("wait_all_for", &ActivitySet::wait_all_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
 974            "Wait for the completion of all activities in the set, but not longer than the provided timeout")
 975       .def("wait_all", &ActivitySet::wait_all, py::call_guard<py::gil_scoped_release>(),
 976            "Wait for the completion of all activities in the set, endlessly")
 977       .def("test_any", &ActivitySet::test_any, py::call_guard<py::gil_scoped_release>(),
 978            "Returns the first terminated activity if any, or None if no activity is terminated")
 979       .def("wait_any_for", &ActivitySet::wait_any_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
 980            "Wait for the completion of one activity in the set, but not longer than the provided timeout")
 981       .def("wait_any", &ActivitySet::wait_any, py::call_guard<py::gil_scoped_release>(),
 982            "Wait for the completion of one activity in the set, endlessly")
 983
 984       .def(
 985           "__repr__", [](const ActivitySetPtr as) { return "ActivitySet([...])"; },
 986           "Textual representation of the ActivitySet");
 987 }