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