src/bindings/python/simgrid_python.cpp

   1 /* Copyright (c) 2018-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifdef _WIN32
   7 #warning Try to work around https://bugs.python.org/issue11566
   8 #define _hypot hypot
   9 #endif
  10
  11 #if defined(__GNUG__)
  12 #pragma GCC diagnostic push
  13 #pragma GCC diagnostic ignored "-Wunused-value"
  14 #endif
  15
  16 #include <pybind11/pybind11.h> // Must come before our own stuff
  17
  18 #include <pybind11/functional.h>
  19 #include <pybind11/stl.h>
  20
  21 #if defined(__GNUG__)
  22 #pragma GCC diagnostic pop
  23 #endif
  24
  25 #include "simgrid/kernel/ProfileBuilder.hpp"
  26 #include "simgrid/kernel/routing/NetPoint.hpp"
  27 #include <simgrid/Exception.hpp>
  28 #include <simgrid/s4u/Actor.hpp>
  29 #include <simgrid/s4u/Comm.hpp>
  30 #include <simgrid/s4u/Disk.hpp>
  31 #include <simgrid/s4u/Engine.hpp>
  32 #include <simgrid/s4u/Exec.hpp>
  33 #include <simgrid/s4u/Host.hpp>
  34 #include <simgrid/s4u/Link.hpp>
  35 #include <simgrid/s4u/Mailbox.hpp>
  36 #include <simgrid/s4u/NetZone.hpp>
  37 #include <simgrid/version.h>
  38
  39 #include <algorithm>
  40 #include <memory>
  41 #include <string>
  42 #include <vector>
  43
  44 namespace py = pybind11;
  45 using simgrid::s4u::Actor;
  46 using simgrid::s4u::ActorPtr;
  47 using simgrid::s4u::Engine;
  48 using simgrid::s4u::Host;
  49 using simgrid::s4u::Link;
  50 using simgrid::s4u::Mailbox;
  51
  52 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
  53
  54 namespace {
  55
  56 std::string get_simgrid_version()
  57 {
  58   int major;
  59   int minor;
  60   int patch;
  61   sg_version_get(&major, &minor, &patch);
  62   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
  63 }
  64
  65 /** @brief Wrap for mailbox::get_async */
  66 class PyGetAsync {
  67   std::unique_ptr<PyObject*> data = std::make_unique<PyObject*>();
  68
  69 public:
  70   PyObject** get() const { return data.get(); }
  71 };
  72
  73 } // namespace
  74
  75 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
  76
  77 PYBIND11_MODULE(simgrid, m)
  78 {
  79   m.doc() = "SimGrid userspace API";
  80
  81   m.attr("simgrid_version") = get_simgrid_version();
  82
  83   // Swapped contexts are broken, starting from pybind11 v2.8.0.  Use thread contexts by default.
  84   simgrid::s4u::Engine::set_config("contexts/factory:thread");
  85
  86   // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
  87   static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
  88
  89   py::register_exception<simgrid::NetworkFailureException>(m, "NetworkFailureException");
  90   py::register_exception<simgrid::TimeoutException>(m, "TimeoutException");
  91   py::register_exception<simgrid::HostFailureException>(m, "HostFailureException");
  92   py::register_exception<simgrid::StorageFailureException>(m, "StorageFailureException");
  93   py::register_exception<simgrid::VmFailureException>(m, "VmFailureException");
  94   py::register_exception<simgrid::CancelException>(m, "CancelException");
  95
  96   /* this_actor namespace */
  97   m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.")
  98       .def(
  99           "debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.")
 100       .def(
 101           "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
 102       .def(
 103           "warning", [](const char* s) { XBT_WARN("%s", s); }, "Display a logging message of 'warning' priority.")
 104       .def(
 105           "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
 106       .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
 107            py::call_guard<py::gil_scoped_release>(),
 108            "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
 109            py::arg("priority") = 1)
 110       .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
 111            py::call_guard<py::gil_scoped_release>())
 112       .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
 113       .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<py::gil_scoped_release>(),
 114            "Moves the current actor to another host.", py::arg("dest"))
 115       .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
 116            py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping for that amount of seconds.",
 117            py::arg("duration"))
 118       .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
 119            py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping until the specified timestamp.",
 120            py::arg("duration"))
 121       .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<py::gil_scoped_release>(),
 122            "Suspend the current actor, that is blocked until resume()ed by another actor.")
 123       .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<py::gil_scoped_release>(), "Yield the actor")
 124       .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<py::gil_scoped_release>(), "kill the current actor")
 125       .def(
 126           "on_exit",
 127           [](py::object cb) {
 128             py::function fun = py::reinterpret_borrow<py::function>(cb);
 129             fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
 130             simgrid::s4u::this_actor::on_exit([fun](bool failed) {
 131               py::gil_scoped_acquire py_context; // need a new context for callback
 132               try {
 133                 fun(failed);
 134               } catch (const py::error_already_set& e) {
 135                 xbt_die("Error while executing the on_exit lambda: %s", e.what());
 136               }
 137             });
 138           },
 139           py::call_guard<py::gil_scoped_release>(),
 140           "Define a lambda to be called when the actor ends. It takes a bool parameter indicating whether the actor "
 141           "was killed. If False, the actor finished peacefully.")
 142       .def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
 143       .def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
 144            "Retrieves PPID of the current actor (i.e., the PID of its parent).");
 145
 146   /* Class Engine */
 147   py::class_<Engine>(m, "Engine", "Simulation Engine")
 148       .def(py::init([](std::vector<std::string> args) {
 149              auto argc = static_cast<int>(args.size());
 150              std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
 151              std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
 152              // Currently this can be dangling, we should wrap this somehow.
 153              return new simgrid::s4u::Engine(&argc, argv.data());
 154            }),
 155            "The constructor should take the parameters from the command line, as is ")
 156       .def_static("get_clock",
 157                   []() // XBT_ATTRIB_DEPRECATED_v334
 158                   {
 159                     PyErr_WarnEx(
 160                         PyExc_DeprecationWarning,
 161                         "get_clock() is deprecated and  will be dropped after v3.33, use `Engine.clock` instead.", 1);
 162                     return Engine::get_clock();
 163                   })
 164       .def_property_readonly_static(
 165           "clock", [](py::object /* self */) { return Engine::get_clock(); },
 166           "The simulation time, ie the amount of simulated seconds since the simulation start.")
 167       .def_property_readonly_static(
 168           "instance", [](py::object /* self */) { return Engine::get_instance(); }, "Retrieve the simulation engine")
 169       .def("get_all_hosts",
 170            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 171            {
 172              PyErr_WarnEx(PyExc_DeprecationWarning,
 173                           "get_all_hosts() is deprecated and  will be dropped after v3.33, use all_hosts instead.", 1);
 174              return self.attr("all_hosts");
 175            })
 176       .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
 177       .def("get_all_links",
 178            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 179            {
 180              PyErr_WarnEx(PyExc_DeprecationWarning,
 181                           "get_all_links() is deprecated and  will be dropped after v3.33, use all_links instead.", 1);
 182              return self.attr("all_links");
 183            })
 184       .def_property_readonly("all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
 185       .def("get_all_netpoints",
 186            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 187            {
 188              PyErr_WarnEx(
 189                  PyExc_DeprecationWarning,
 190                  "get_all_netpoints() is deprecated and  will be dropped after v3.33, use all_netpoints instead.", 1);
 191              return self.attr("all_netpoints");
 192            })
 193       .def_property_readonly("all_netpoints", &Engine::get_all_netpoints)
 194       .def("get_netzone_root",
 195            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 196            {
 197              PyErr_WarnEx(PyExc_DeprecationWarning,
 198                           "get_netzone_root() is deprecated and  will be dropped after v3.3, use netzone_root instead.",
 199                           1);
 200              return self.attr("netzone_root");
 201            })
 202       .def_property_readonly("netzone_root", &Engine::get_netzone_root,
 203                              "Retrieve the root netzone, containing all others.")
 204       .def("netpoint_by_name", &Engine::netpoint_by_name_or_null)
 205       .def("netzone_by_name", &Engine::netzone_by_name_or_null)
 206       .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
 207       .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
 208       .def("run", &Engine::run, py::call_guard<py::gil_scoped_release>(), "Run the simulation until its end")
 209       .def("run_until", py::overload_cast<double>(&Engine::run_until, py::const_),
 210            py::call_guard<py::gil_scoped_release>(), "Run the simulation until the given date",
 211            py::arg("max_date") = -1)
 212       .def(
 213           "register_actor",
 214           [](Engine* e, const std::string& name, py::object fun_or_class) {
 215             e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
 216               py::gil_scoped_acquire py_context;
 217               try {
 218                 /* Convert the std::vector into a py::tuple */
 219                 py::tuple params(args.size() - 1);
 220                 for (size_t i = 1; i < args.size(); i++)
 221                   params[i - 1] = py::cast(args[i]);
 222
 223                 py::object res = fun_or_class(*params);
 224                 /* If I was passed a class, I just built an instance, so I need to call it now */
 225                 if (py::isinstance<py::function>(res))
 226                   res();
 227               } catch (const py::error_already_set& ex) {
 228                 if (ex.matches(pyForcefulKillEx)) {
 229                   XBT_VERB("Actor killed");
 230                   simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
 231                 }
 232                 throw;
 233               }
 234             });
 235           },
 236           "Registers the main function of an actor");
 237
 238   /* Class Netzone */
 239   py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>> netzone(
 240       m, "NetZone", "Networking Zones. See the C++ documentation for details.");
 241   netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
 242       .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
 243       .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
 244       .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
 245       .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
 246       .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd")
 247       .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra")
 248       .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi")
 249       .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty")
 250       .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi")
 251       .def("add_route",
 252            py::overload_cast<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
 253                              simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
 254                              const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
 255            "Add a route between 2 netpoints")
 256       .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
 257            "Creates a host")
 258       .def("create_host",
 259            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
 260            "Creates a host")
 261       .def("create_host",
 262            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
 263            "Creates a host")
 264       .def("create_host",
 265            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
 266            "Creates a host")
 267       .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
 268            "Creates a network link")
 269       .def("create_link",
 270            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
 271            "Creates a network link")
 272       .def("create_link",
 273            py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
 274            "Creates a network link")
 275       .def("create_link",
 276            py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
 277            "Creates a network link")
 278       .def("create_split_duplex_link",
 279            py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
 280            "Creates a split-duplex link")
 281       .def("create_split_duplex_link",
 282            py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
 283            "Creates a split-duplex link")
 284       .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
 285       .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
 286       .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
 287       .def("get_netpoint",
 288            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 289            {
 290              PyErr_WarnEx(PyExc_DeprecationWarning,
 291                           "get_netpoint() is deprecated and  will be dropped after v3.33, use netpoint instead.", 1);
 292              return self.attr("netpoint");
 293            })
 294       .def_property_readonly("netpoint", &simgrid::s4u::NetZone::get_netpoint,
 295                              "Retrieve the netpoint associated to this zone")
 296       .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
 297       .def_property_readonly(
 298           "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); },
 299           "The name of this network zone (read-only property).");
 300
 301   /* Class ClusterCallbacks */
 302   py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
 303       .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
 304                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
 305                     const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
 306
 307   /* Class FatTreeParams */
 308   py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
 309       .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
 310                     const std::vector<unsigned int>&>());
 311
 312   /* Class DragonflyParams */
 313   py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
 314       .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
 315                     const std::pair<unsigned int, unsigned int>&, unsigned int>());
 316
 317   /* Class Host */
 318   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
 319       m, "Host", "Simulated host. See the C++ documentation for details.");
 320   host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die")
 321       .def(
 322           "route_to",
 323           [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
 324             auto* list = new std::vector<Link*>();
 325             double bw  = 0;
 326             h->route_to(to, *list, &bw);
 327             return make_tuple(list, bw);
 328           },
 329           "Retrieves the list of links and the bandwidth between two hosts.")
 330       .def(
 331           "set_speed_profile",
 332           [](Host* h, const std::string& profile, double period) {
 333             h->set_speed_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 334           },
 335           py::call_guard<py::gil_scoped_release>(),
 336           "Specify a profile modeling the external load according to an exhaustive list. "
 337           "Each line of the profile describes timed events as ``date ratio``. "
 338           "For example, the following content describes an host which computational speed is initially 1 (i.e, 100%) "
 339           "and then halved after 42 seconds:\n\n"
 340           ".. code-block:: python\n\n"
 341           "   \"\"\"\n"
 342           "   0 1.0\n"
 343           "   42 0.5\n"
 344           "   \"\"\"\n\n"
 345           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 346           " while speed profiles of hosts contain ratios.\n\n"
 347           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 348           "the list. Set it to -1 to not loop over.")
 349       .def(
 350           "set_state_profile",
 351           [](Host* h, const std::string& profile, double period) {
 352             h->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 353           },
 354           py::call_guard<py::gil_scoped_release>(),
 355           "Specify a profile modeling the churn. "
 356           "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
 357           "whether the host is on. "
 358           "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
 359           ".. code-block:: python\n\n"
 360           "   \"\"\"\n"
 361           "   1.0 0\n"
 362           "   2.0 1\n"
 363           "   \"\"\"\n\n"
 364           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 365           "the list. Set it to -1 to not loop over.")
 366       .def("get_pstate_count",
 367            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 368            {
 369              PyErr_WarnEx(
 370                  PyExc_DeprecationWarning,
 371                  "get_pstate_count() is deprecated and  will be dropped after v3.33, use pstate_count instead.", 1);
 372              return self.attr("pstate_count");
 373            })
 374       .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
 375       .def("get_pstate_speed",
 376            [](py::object self, int state) // XBT_ATTRIB_DEPRECATED_v334
 377            {
 378              PyErr_WarnEx(
 379                  PyExc_DeprecationWarning,
 380                  "get_pstate_speed() is deprecated and  will be dropped after v3.33, use pstate_speed instead.", 1);
 381              return self.attr("pstate_speed")(state);
 382            })
 383       .def("pstate_speed", &Host::get_pstate_speed, py::call_guard<py::gil_scoped_release>(),
 384            "Retrieve the maximal speed at the given pstate")
 385       .def("get_netpoint",
 386            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 387            {
 388              PyErr_WarnEx(PyExc_DeprecationWarning,
 389                           "get_netpoint() is deprecated and  will be dropped after v3.33, use netpoint instead.", 1);
 390              return self.attr("netpoint");
 391            })
 392       .def_property_readonly("netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this zone")
 393       .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
 394       .def("set_core_count",
 395            [](py::object self, double count) // XBT_ATTRIB_DEPRECATED_v334
 396            {
 397              PyErr_WarnEx(PyExc_DeprecationWarning,
 398                           "set_core_count() is deprecated and  will be dropped after v3.33, use core_count instead.",
 399                           1);
 400              self.attr("core_count")(count);
 401            })
 402       .def_property(
 403           "core_count", &Host::get_core_count,
 404           [](Host* h, int count) {
 405             py::gil_scoped_release gil_guard;
 406             return h->set_core_count(count);
 407           },
 408           "Manage the number of cores in the CPU")
 409       .def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
 410            "Set the coordinates of this host")
 411       .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 412            "Describe how the CPU is shared", py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 413       .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk),
 414            py::call_guard<py::gil_scoped_release>(), "Create a disk")
 415       .def("create_disk",
 416            py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
 417            py::call_guard<py::gil_scoped_release>(), "Create a disk")
 418       .def("seal", &Host::seal, py::call_guard<py::gil_scoped_release>(), "Seal this host")
 419       .def_property(
 420           "pstate", &Host::get_pstate,
 421           [](Host* h, int i) {
 422             py::gil_scoped_release gil_guard;
 423             h->set_pstate(i);
 424           },
 425           "The current pstate (read/write property).")
 426       .def_static("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
 427            "Retrieves the host on which the running actor is located.")
 428       .def_property_readonly(
 429           "name",
 430           [](const Host* self) {
 431             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 432           },
 433           "The name of this host (read-only property).")
 434       .def_property_readonly("load", &Host::get_load,
 435                              "Returns the current computation load (in flops per second), NOT taking the external load "
 436                              "into account. This is the currently achieved speed (read-only property).")
 437       .def_property_readonly(
 438           "speed", &Host::get_speed,
 439           "The peak computing speed in flops/s at the current pstate, NOT taking the external load into account. "
 440           "This is the max potential speed (read-only property).")
 441       .def_property_readonly("available_speed", &Host::get_available_speed,
 442                              "Get the available speed ratio, between 0 and 1.\n"
 443                              "This accounts for external load (see :py:func:`set_speed_profile() "
 444                              "<simgrid.Host.set_speed_profile>`) (read-only property).")
 445       .def_static(
 446           "on_creation_cb",
 447           [](py::object cb) {
 448             Host::on_creation_cb([cb](Host& h) {
 449               py::function fun = py::reinterpret_borrow<py::function>(cb);
 450               py::gil_scoped_acquire py_context; // need a new context for callback
 451               try {
 452                 fun(&h);
 453               } catch (const py::error_already_set& e) {
 454                 xbt_die("Error while executing the on_creation lambda : %s", e.what());
 455               }
 456             });
 457           },
 458           py::call_guard<py::gil_scoped_release>(), "");
 459
 460   py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
 461       .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
 462       .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR)
 463       .export_values();
 464
 465   /* Class Disk */
 466   py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(
 467       m, "Disk", "Simulated disk. See the C++ documentation for details.");
 468   disk.def("read", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::read, py::const_),
 469            py::call_guard<py::gil_scoped_release>(), "Read data from disk", py::arg("size"), py::arg("priority") = 1)
 470       .def("write", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::write, py::const_),
 471            py::call_guard<py::gil_scoped_release>(), "Write data in disk", py::arg("size"), py::arg("priority") = 1)
 472       .def("read_async", &simgrid::s4u::Disk::read_async, py::call_guard<py::gil_scoped_release>(),
 473            "Non-blocking read data from disk")
 474       .def("write_async", &simgrid::s4u::Disk::write_async, py::call_guard<py::gil_scoped_release>(),
 475            "Non-blocking write data in disk")
 476       .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 477            "Set sharing policy for this disk", py::arg("op"), py::arg("policy"),
 478            py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
 479       .def("seal", &simgrid::s4u::Disk::seal, py::call_guard<py::gil_scoped_release>(), "Seal this disk")
 480       .def_property_readonly(
 481           "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); },
 482           "The name of this disk (read-only property).");
 483   py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
 484       .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
 485       .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR)
 486       .export_values();
 487   py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
 488       .value("READ", simgrid::s4u::Disk::Operation::READ)
 489       .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
 490       .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE)
 491       .export_values();
 492
 493   /* Class NetPoint */
 494   py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
 495       netpoint(m, "NetPoint", "NetPoint object");
 496
 497   /* Class Link */
 498   py::class_<Link, std::unique_ptr<Link, py::nodelete>> link(m, "Link",
 499                                                              "Network link. See the C++ documentation for details.");
 500   link.def("set_latency", py::overload_cast<const std::string&>(&Link::set_latency),
 501            py::call_guard<py::gil_scoped_release>(),
 502            "Set the latency as a string. Accepts values with units, such as ‘1s’ or ‘7ms’.\nFull list of accepted "
 503            "units: w (week), d (day), h, s, ms, us, ns, ps.")
 504       .def("set_latency", py::overload_cast<double>(&Link::set_latency), py::call_guard<py::gil_scoped_release>(),
 505            "Set the latency as a float (in seconds).")
 506       .def("set_bandwidth", &Link::set_bandwidth, py::call_guard<py::gil_scoped_release>(),
 507            "Set the bandwidth (in byte per second).")
 508       .def(
 509           "set_bandwidth_profile",
 510           [](Link* l, const std::string& profile, double period) {
 511             l->set_bandwidth_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 512           },
 513           py::call_guard<py::gil_scoped_release>(),
 514           "Specify a profile modeling the external load according to an exhaustive list. "
 515           "Each line of the profile describes timed events as ``date bandwidth`` (in bytes per second). "
 516           "For example, the following content describes a link which bandwidth changes to 40 Mb/s at t=4, and to 6 "
 517           "Mb/s at t=8:\n\n"
 518           ".. code-block:: python\n\n"
 519           "   \"\"\"\n"
 520           "   4.0 40000000\n"
 521           "   8.0 60000000\n"
 522           "   \"\"\"\n\n"
 523           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 524           " while speed profiles of hosts contain ratios.\n\n"
 525           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 526           "the list. Set it to -1 to not loop over.")
 527       .def(
 528           "set_latency_profile",
 529           [](Link* l, const std::string& profile, double period) {
 530             l->set_latency_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 531           },
 532           py::call_guard<py::gil_scoped_release>(),
 533           "Specify a profile modeling the external load according to an exhaustive list. "
 534           "Each line of the profile describes timed events as ``date latency`` (in seconds). "
 535           "For example, the following content describes a link which latency changes to 1ms (0.001s) at t=1, and to 2s "
 536           "at t=2:\n\n"
 537           ".. code-block:: python\n\n"
 538           "   \"\"\"\n"
 539           "   1.0 0.001\n"
 540           "   2.0 2\n"
 541           "   \"\"\"\n\n"
 542           ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
 543           " while speed profiles of hosts contain ratios.\n\n"
 544           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 545           "the list. Set it to -1 to not loop over.")
 546       .def(
 547           "set_state_profile",
 548           [](Link* l, const std::string& profile, double period) {
 549             l->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
 550           },
 551           "Specify a profile modeling the churn. "
 552           "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
 553           "whether the link is on. "
 554           "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
 555           ".. code-block:: python\n\n"
 556           "   \"\"\"\n"
 557           "   1.0 0\n"
 558           "   2.0 1\n"
 559           "   \"\"\"\n\n"
 560           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
 561           "the list. Set it to -1 to not loop over.")
 562
 563       .def("turn_on", &Link::turn_on, py::call_guard<py::gil_scoped_release>(), "Turns the link on.")
 564       .def("turn_off", &Link::turn_off, py::call_guard<py::gil_scoped_release>(), "Turns the link off.")
 565       .def("is_on", &Link::is_on, "Check whether the link is on.")
 566
 567       .def("set_sharing_policy", &Link::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
 568            "Set sharing policy for this link")
 569       .def("set_concurrency_limit", &Link::set_concurrency_limit, py::call_guard<py::gil_scoped_release>(),
 570            "Set concurrency limit for this link")
 571       .def("set_host_wifi_rate", &Link::set_host_wifi_rate, py::call_guard<py::gil_scoped_release>(),
 572            "Set level of communication speed of given host on this Wi-Fi link")
 573       .def_static("by_name", &Link::by_name, "Retrieves a Link from its name, or dies")
 574       .def("seal", &Link::seal, py::call_guard<py::gil_scoped_release>(), "Seal this link")
 575       .def_property_readonly(
 576           "name",
 577           [](const Link* self) {
 578             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 579           },
 580           "The name of this link")
 581       .def_property_readonly("bandwidth", &Link::get_bandwidth,
 582                              "The bandwidth (in bytes per second) (read-only property).")
 583       .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property).");
 584
 585   py::enum_<Link::SharingPolicy>(link, "SharingPolicy")
 586       .value("NONLINEAR", Link::SharingPolicy::NONLINEAR)
 587       .value("WIFI", Link::SharingPolicy::WIFI)
 588       .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX)
 589       .value("SHARED", Link::SharingPolicy::SHARED)
 590       .value("FATPIPE", Link::SharingPolicy::FATPIPE)
 591       .export_values();
 592
 593   /* Class LinkInRoute */
 594   py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
 595   linkinroute.def(py::init<const Link*>());
 596   linkinroute.def(py::init<const Link*, simgrid::s4u::LinkInRoute::Direction>());
 597   py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
 598       .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
 599       .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
 600       .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE)
 601       .export_values();
 602
 603   /* Class Split-Duplex Link */
 604   py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
 605       m, "SplitDuplexLink", "Network split-duplex link")
 606       .def("get_link_up",
 607            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 608            {
 609              PyErr_WarnEx(PyExc_DeprecationWarning,
 610                           "get_link_up() is deprecated and  will be dropped after v3.33, use link_up instead.", 1);
 611              return self.attr("link_up");
 612            })
 613       .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
 614       .def("get_link_down",
 615            [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
 616            {
 617              PyErr_WarnEx(PyExc_DeprecationWarning,
 618                           "get_link_down() is deprecated and  will be dropped after v3.33, use link_down instead.", 1);
 619              return self.attr("link_down");
 620            })
 621       .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
 622
 623   /* Class Mailbox */
 624   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
 625       m, "Mailbox", "Mailbox. See the C++ documentation for details.")
 626       .def(
 627           "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
 628           "Textual representation of the Mailbox`")
 629       .def_static("by_name", &Mailbox::by_name,
 630                   py::call_guard<py::gil_scoped_release>(),
 631                   py::arg("name"),
 632                   "Retrieve a Mailbox from its name")
 633       .def_property_readonly(
 634           "name",
 635           [](const Mailbox* self) {
 636             return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 637           },
 638           "The name of that mailbox (read-only property).")
 639       .def(
 640           "put",
 641           [](Mailbox* self, py::object data, int size, double timeout) {
 642             data.inc_ref();
 643             self->put(data.ptr(), size, timeout);
 644           },
 645           py::call_guard<py::gil_scoped_release>(), "Blocking data transmission with a timeout")
 646       .def(
 647           "put",
 648           [](Mailbox* self, py::object data, int size) {
 649             data.inc_ref();
 650             self->put(data.ptr(), size);
 651           },
 652           py::call_guard<py::gil_scoped_release>(), "Blocking data transmission")
 653       .def(
 654           "put_async",
 655           [](Mailbox* self, py::object data, int size) {
 656             data.inc_ref();
 657             return self->put_async(data.ptr(), size);
 658           },
 659           py::call_guard<py::gil_scoped_release>(), "Non-blocking data transmission")
 660       .def(
 661           "put_init",
 662           [](Mailbox* self, py::object data, int size) {
 663             data.inc_ref();
 664             return self->put_init(data.ptr(), size);
 665           },
 666           py::call_guard<py::gil_scoped_release>(),
 667           "Creates (but don’t start) a data transmission to that mailbox.")
 668       .def(
 669           "get",
 670           [](Mailbox* self) {
 671             py::object data = py::reinterpret_steal<py::object>(self->get<PyObject>());
 672             // data.dec_ref(); // FIXME: why does it break python-actor-create?
 673             return data;
 674           },
 675           py::call_guard<py::gil_scoped_release>(), "Blocking data reception")
 676       .def(
 677           "get_async",
 678           [](Mailbox* self) -> std::tuple<simgrid::s4u::CommPtr, PyGetAsync> {
 679             PyGetAsync wrap;
 680             auto comm = self->get_async(wrap.get());
 681             return std::make_tuple(std::move(comm), std::move(wrap));
 682           },
 683           py::call_guard<py::gil_scoped_release>(),
 684           "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
 685       .def(
 686           "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); },
 687           py::call_guard<py::gil_scoped_release>(), "Sets the actor as permanent receiver");
 688
 689   /* Class PyGetAsync */
 690   py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
 691       .def(py::init<>())
 692       .def(
 693           "get", [](const PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
 694           "Get python object after async communication in receiver side");
 695
 696   /* Class Comm */
 697   py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
 698                                                         "Communication. See the C++ documentation for details.")
 699       .def("test", &simgrid::s4u::Comm::test, py::call_guard<py::gil_scoped_release>(),
 700            "Test whether the communication is terminated.")
 701       .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<py::gil_scoped_release>(),
 702            "Block until the completion of that communication.")
 703       .def("wait_for", &simgrid::s4u::Comm::wait_for,
 704            py::arg("timeout"),
 705            py::call_guard<py::gil_scoped_release>(),
 706            "Block until the completion of that communication, or raises TimeoutException after the specified timeout.")
 707       .def("detach", [](simgrid::s4u::Comm* self) {
 708               return self->detach();
 709            },
 710            py::return_value_policy::reference_internal,
 711            py::call_guard<py::gil_scoped_release>(),
 712            "Start the comm, and ignore its result. It can be completely forgotten after that.")
 713       // use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
 714       .def_static(
 715           "wait_all", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
 716           py::arg("comms"),
 717           py::call_guard<py::gil_scoped_release>(),
 718           "Block until the completion of all communications in the list.")
 719       .def_static("wait_all_for", &simgrid::s4u::Comm::wait_all_for,
 720                   py::arg("comms"), py::arg("timeout"),
 721                   py::call_guard<py::gil_scoped_release>(),
 722                   "Block until the completion of all communications in the list, or raises TimeoutException after "
 723                   "the specified timeout.")
 724       .def_static(
 725           "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
 726           py::arg("comms"),
 727           py::call_guard<py::gil_scoped_release>(),
 728           "Block until the completion of any communication in the list and return the index of the terminated one.")
 729       .def_static(
 730           "wait_any_for",
 731           py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&, double>(&simgrid::s4u::Comm::wait_any_for),
 732           py::arg("comms"), py::arg("timeout"),
 733           py::call_guard<py::gil_scoped_release>(),
 734           "Block until the completion of any communication in the list and return the index of the terminated "
 735           "one, or -1 if a timeout occurred."
 736       );
 737
 738   /* Class Io */
 739   py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities. See the C++ documentation for details.")
 740       .def("test", &simgrid::s4u::Io::test, py::call_guard<py::gil_scoped_release>(),
 741            "Test whether the I/O is terminated.")
 742       .def("wait", &simgrid::s4u::Io::wait, py::call_guard<py::gil_scoped_release>(),
 743            "Block until the completion of that I/O operation")
 744       .def_static(
 745           "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard<py::gil_scoped_release>(),
 746           "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.")
 747       .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard<py::gil_scoped_release>(),
 748                   "Block until the completion of any I/O in the list and return the index of the terminated one.");
 749
 750   /* Class Exec */
 751   py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution. See the C++ documentation for details.")
 752       .def_property_readonly(
 753           "remaining",
 754           [](simgrid::s4u::ExecPtr self) {
 755             py::gil_scoped_release gil_guard;
 756             return self->get_remaining();
 757           },
 758           "Amount of flops that remain to be computed until completion (read-only property).")
 759       .def_property_readonly(
 760           "remaining_ratio",
 761           [](simgrid::s4u::ExecPtr self) {
 762             py::gil_scoped_release gil_guard;
 763             return self->get_remaining_ratio();
 764           },
 765           "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
 766           "yet) (read-only property).")
 767       .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
 768                     "Host on which this execution runs. Only the first host is returned for parallel executions. "
 769                     "Changing this value migrates the execution.")
 770       .def("test", &simgrid::s4u::Exec::test, py::call_guard<py::gil_scoped_release>(),
 771            "Test whether the execution is terminated.")
 772       .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<py::gil_scoped_release>(), "Cancel that execution.")
 773       .def("start", &simgrid::s4u::Exec::start, py::call_guard<py::gil_scoped_release>(), "Start that execution.")
 774       .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<py::gil_scoped_release>(),
 775            "Block until the completion of that execution.");
 776
 777   /* Class Actor */
 778   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 779                                             "An actor is an independent stream of execution in your distributed "
 780                                             "application. See the C++ documentation for details.")
 781       .def(
 782           "create",
 783           [](py::str name, Host* h, py::object fun, py::args args) {
 784             fun.inc_ref();  // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
 785             args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
 786             return simgrid::s4u::Actor::create(name, h, [fun, args]() {
 787               py::gil_scoped_acquire py_context;
 788               try {
 789                 fun(*args);
 790               } catch (const py::error_already_set& ex) {
 791                 if (ex.matches(pyForcefulKillEx)) {
 792                   XBT_VERB("Actor killed");
 793                   simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
 794                 }
 795                 throw;
 796               }
 797             });
 798           },
 799           py::call_guard<py::gil_scoped_release>(),
 800           "Create an actor from a function or an object. See the :ref:`example <s4u_ex_actors_create>`.")
 801       .def_property(
 802           "host", &Actor::get_host,
 803           [](Actor* a, Host* h) {
 804             py::gil_scoped_release gil_guard;
 805             a->set_host(h);
 806           },
 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"))
 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>(), "Kill all actors but the caller.");
 836 }