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