1 /* Copyright (c) 2018-2022. The SimGrid Team. All rights reserved. */
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. */
7 #warning Try to work around https://bugs.python.org/issue11566
12 #pragma GCC diagnostic push
13 #pragma GCC diagnostic ignored "-Wunused-value"
16 #include <pybind11/pybind11.h> // Must come before our own stuff
18 #include <pybind11/functional.h>
19 #include <pybind11/stl.h>
22 #pragma GCC diagnostic pop
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>
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;
53 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
57 std::string get_simgrid_version()
62 sg_version_get(&major, &minor, &patch);
63 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
66 /** @brief Wrap for mailbox::get_async */
68 std::unique_ptr<PyObject*> data = std::make_unique<PyObject*>();
71 PyObject** get() const { return data.get(); }
76 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
78 PYBIND11_MODULE(simgrid, m)
80 m.doc() = "SimGrid userspace API";
82 m.attr("simgrid_version") = get_simgrid_version();
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");
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"));
90 py::register_exception<simgrid::NetworkFailureException>(m, "NetworkFailureException");
91 py::register_exception<simgrid::TimeoutException>(m, "TimeoutException");
93 /* this_actor namespace */
94 m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.")
96 "debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.")
98 "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
100 "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
101 .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
102 py::call_guard<py::gil_scoped_release>(),
103 "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
104 py::arg("priority") = 1)
105 .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
106 py::call_guard<py::gil_scoped_release>())
107 .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
108 .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<py::gil_scoped_release>(),
109 "Moves the current actor to another host.", py::arg("dest"))
110 .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
111 py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping for that amount of seconds.",
113 .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
114 py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping until the specified timestamp.",
116 .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<py::gil_scoped_release>(),
117 "Suspend the current actor, that is blocked until resume()ed by another actor.")
118 .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<py::gil_scoped_release>(), "Yield the actor")
119 .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<py::gil_scoped_release>(), "kill the current actor")
123 py::function fun = py::reinterpret_borrow<py::function>(cb);
124 fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
125 simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
127 py::gil_scoped_acquire py_context; // need a new context for callback
129 } catch (const py::error_already_set& e) {
130 xbt_die("Error while executing the on_exit lambda: %s", e.what());
134 py::call_guard<py::gil_scoped_release>(), "")
135 .def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
136 .def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
137 "Retrieves PPID of the current actor (i.e., the PID of its parent).");
140 py::class_<Engine>(m, "Engine", "Simulation Engine")
141 .def(py::init([](std::vector<std::string> args) {
142 auto argc = static_cast<int>(args.size());
143 std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
144 std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
145 // Currently this can be dangling, we should wrap this somehow.
146 return new simgrid::s4u::Engine(&argc, argv.data());
148 "The constructor should take the parameters from the command line, as is ")
149 .def_static("get_clock",
150 [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334
152 PyErr_WarnEx(PyExc_DeprecationWarning,
153 "get_clock() is deprecated and will be dropped after v3.33, use clock() instead.", 1);
154 return self.attr("clock");
156 .def_property_readonly_static(
157 "clock", [](py::object /* self */) { return Engine::get_clock(); },
158 "The simulation time, ie the amount of simulated seconds since the simulation start.")
159 .def_property_readonly_static(
160 "instance", [](py::object /* self */) { return Engine::get_instance(); }, "Retrieve the simulation engine")
161 .def("get_all_hosts",
162 [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334
164 PyErr_WarnEx(PyExc_DeprecationWarning,
165 "get_all_hosts() is deprecated and will be dropped after v3.33, use all_host() instead.", 1);
166 return self.attr("all_hosts");
168 .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
169 .def("get_all_links",
170 [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334
172 PyErr_WarnEx(PyExc_DeprecationWarning,
173 "get_all_links() is deprecated and will be dropped after v3.33, use all_links() instead.",
175 return self.attr("all_links");
177 .def_property_readonly("all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
178 .def("get_all_netpoints",
179 [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334
182 PyExc_DeprecationWarning,
183 "get_all_netpoints() is deprecated and will be dropped after v3.33, use all_netpoints() instead.", 1);
184 return self.attr("all_netpoints");
186 .def_property_readonly("all_netpoints", &Engine::get_all_netpoints)
187 .def("get_netzone_root",
188 [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334
191 PyExc_DeprecationWarning,
192 "get_netzone_root() is deprecated and will be dropped after v3.3, use netzone_root() instead.", 1);
193 return self.attr("netzone_root");
195 .def_property_readonly("netzone_root", &Engine::get_netzone_root,
196 "Retrieve the root netzone, containing all others.")
197 .def("netpoint_by_name", &Engine::netpoint_by_name_or_null)
198 .def("netzone_by_name", &Engine::netzone_by_name_or_null)
199 .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
200 .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
201 .def("run", &Engine::run, py::call_guard<py::gil_scoped_release>(), "Run the simulation until its end")
202 .def("run_until", py::overload_cast<double>(&Engine::run_until, py::const_),
203 py::call_guard<py::gil_scoped_release>(), "Run the simulation until the given date",
204 py::arg("max_date") = -1)
207 [](Engine* e, const std::string& name, py::object fun_or_class) {
208 e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
210 py::gil_scoped_acquire py_context;
211 /* Convert the std::vector into a py::tuple */
212 py::tuple params(args.size() - 1);
213 for (size_t i = 1; i < args.size(); i++)
214 params[i - 1] = py::cast(args[i]);
216 py::object res = fun_or_class(*params);
217 /* If I was passed a class, I just built an instance, so I need to call it now */
218 if (py::isinstance<py::function>(res))
220 } catch (const py::error_already_set& ex) {
221 if (ex.matches(pyForcefulKillEx)) {
222 XBT_VERB("Actor killed");
223 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
229 "Registers the main function of an actor");
232 py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>> netzone(
233 m, "NetZone", "Networking Zones. See the C++ documentation for details.");
234 netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
235 .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
236 .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
237 .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
238 .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
239 .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd")
240 .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra")
241 .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi")
242 .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty")
243 .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi")
245 py::overload_cast<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
246 simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
247 const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
248 "Add a route between 2 netpoints")
249 .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
252 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
255 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
258 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
260 .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
261 "Creates a network link")
263 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
264 "Creates a network link")
266 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
267 "Creates a network link")
269 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
270 "Creates a network link")
271 .def("create_split_duplex_link",
272 py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
273 "Creates a split-duplex link")
274 .def("create_split_duplex_link",
275 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
276 "Creates a split-duplex link")
277 .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
278 .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
279 .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
280 .def("get_netpoint", &simgrid::s4u::NetZone::get_netpoint, "Retrieve the netpoint associated to this zone")
281 .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
282 .def_property_readonly(
283 "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); },
284 "The name of this network zone (read-only property).");
286 /* Class ClusterCallbacks */
287 py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
288 .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
289 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
290 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
292 /* Class FatTreeParams */
293 py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
294 .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
295 const std::vector<unsigned int>&>());
297 /* Class DragonflyParams */
298 py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
299 .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
300 const std::pair<unsigned int, unsigned int>&, unsigned int>());
303 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
304 m, "Host", "Simulated host. See the C++ documentation for details.");
305 host.def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
308 [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
309 auto* list = new std::vector<Link*>();
311 h->route_to(to, *list, &bw);
312 return make_tuple(list, bw);
314 "Retrieves the list of links and the bandwidth between two hosts.")
317 [](Host* h, const std::string& profile, double period) {
318 h->set_speed_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
320 py::call_guard<py::gil_scoped_release>(),
321 "Specify a profile modeling the external load according to an exhaustive list. "
322 "Each line of the profile describes timed events as ``date ratio``. "
323 "For example, the following content describes an host which computational speed is initially 1 (i.e, 100%) "
324 "and then halved after 42 seconds:\n\n"
325 ".. code-block:: python\n\n"
330 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
331 " while speed profiles of hosts contain ratios.\n\n"
332 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
333 "the list. Set it to -1 to not loop over.")
336 [](Host* h, const std::string& profile, double period) {
337 h->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
339 py::call_guard<py::gil_scoped_release>(),
340 "Specify a profile modeling the churn. "
341 "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
342 "whether the host is on. "
343 "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
344 ".. code-block:: python\n\n"
349 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
350 "the list. Set it to -1 to not loop over.")
351 .def("get_pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
352 .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
353 .def("get_netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this host")
354 .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
355 .def("set_core_count", &Host::set_core_count, py::call_guard<py::gil_scoped_release>(),
356 "Set the number of cores in the CPU")
357 .def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
358 "Set the coordinates of this host")
359 .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
360 "Describe how the CPU is shared", py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
361 .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk),
362 py::call_guard<py::gil_scoped_release>(), "Create a disk")
364 py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
365 py::call_guard<py::gil_scoped_release>(), "Create a disk")
366 .def("seal", &Host::seal, py::call_guard<py::gil_scoped_release>(), "Seal this host")
368 "pstate", &Host::get_pstate,
370 py::gil_scoped_release gil_guard;
373 "The current pstate (read/write property).")
374 .def("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
375 "Retrieves the host on which the running actor is located.")
376 .def_property_readonly(
378 [](const Host* self) {
379 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
381 "The name of this host (read-only property).")
382 .def_property_readonly("load", &Host::get_load,
383 "Returns the current computation load (in flops per second), NOT taking the external load "
384 "into account. This is the currently achieved speed (read-only property).")
385 .def_property_readonly(
386 "speed", &Host::get_speed,
387 "The peak computing speed in flops/s at the current pstate, NOT taking the external load into account. "
388 "This is the max potential speed (read-only property).")
389 .def_property_readonly("available_speed", &Host::get_available_speed,
390 "Get the available speed ratio, between 0 and 1.\n"
391 "This accounts for external load (see :py:func:`set_speed_profile() "
392 "<simgrid.Host.set_speed_profile>`) (read-only property).")
396 Host::on_creation_cb([cb](Host& h) {
397 py::function fun = py::reinterpret_borrow<py::function>(cb);
399 py::gil_scoped_acquire py_context; // need a new context for callback
401 } catch (const py::error_already_set& e) {
402 xbt_die("Error while executing the on_creation lambda : %s", e.what());
406 py::call_guard<py::gil_scoped_release>(), "");
408 py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
409 .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
410 .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR)
414 py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(
415 m, "Disk", "Simulated disk. See the C++ documentation for details.");
416 disk.def("read", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::read, py::const_),
417 py::call_guard<py::gil_scoped_release>(), "Read data from disk", py::arg("size"), py::arg("priority") = 1)
418 .def("write", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::write, py::const_),
419 py::call_guard<py::gil_scoped_release>(), "Write data in disk", py::arg("size"), py::arg("priority") = 1)
420 .def("read_async", &simgrid::s4u::Disk::read_async, py::call_guard<py::gil_scoped_release>(),
421 "Non-blocking read data from disk")
422 .def("write_async", &simgrid::s4u::Disk::write_async, py::call_guard<py::gil_scoped_release>(),
423 "Non-blocking write data in disk")
424 .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
425 "Set sharing policy for this disk", py::arg("op"), py::arg("policy"),
426 py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
427 .def("seal", &simgrid::s4u::Disk::seal, py::call_guard<py::gil_scoped_release>(), "Seal this disk")
428 .def_property_readonly(
429 "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); },
430 "The name of this disk (read-only property).");
431 py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
432 .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
433 .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR)
435 py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
436 .value("READ", simgrid::s4u::Disk::Operation::READ)
437 .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
438 .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE)
442 py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
443 netpoint(m, "NetPoint", "NetPoint object");
446 py::class_<Link, std::unique_ptr<Link, py::nodelete>> link(m, "Link",
447 "Network link. See the C++ documentation for details.");
448 link.def("set_latency", py::overload_cast<const std::string&>(&Link::set_latency),
449 py::call_guard<py::gil_scoped_release>(),
450 "Set the latency as a string. Accepts values with units, such as ‘1s’ or ‘7ms’.\nFull list of accepted "
451 "units: w (week), d (day), h, s, ms, us, ns, ps.")
452 .def("set_latency", py::overload_cast<double>(&Link::set_latency), py::call_guard<py::gil_scoped_release>(),
453 "Set the latency as a float (in seconds).")
454 .def("set_bandwidth", &Link::set_bandwidth, py::call_guard<py::gil_scoped_release>(),
455 "Set the bandwidth (in byte per second).")
457 "set_bandwidth_profile",
458 [](Link* l, const std::string& profile, double period) {
459 l->set_bandwidth_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
461 py::call_guard<py::gil_scoped_release>(),
462 "Specify a profile modeling the external load according to an exhaustive list. "
463 "Each line of the profile describes timed events as ``date bandwidth`` (in bytes per second). "
464 "For example, the following content describes a link which bandwidth changes to 40 Mb/s at t=4, and to 6 "
466 ".. code-block:: python\n\n"
471 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
472 " while speed profiles of hosts contain ratios.\n\n"
473 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
474 "the list. Set it to -1 to not loop over.")
476 "set_latency_profile",
477 [](Link* l, const std::string& profile, double period) {
478 l->set_latency_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
480 py::call_guard<py::gil_scoped_release>(),
481 "Specify a profile modeling the external load according to an exhaustive list. "
482 "Each line of the profile describes timed events as ``date latency`` (in seconds). "
483 "For example, the following content describes a link which latency changes to 1ms (0.001s) at t=1, and to 2s "
485 ".. code-block:: python\n\n"
490 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
491 " while speed profiles of hosts contain ratios.\n\n"
492 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
493 "the list. Set it to -1 to not loop over.")
496 [](Link* l, const std::string& profile, double period) {
497 l->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
499 "Specify a profile modeling the churn. "
500 "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
501 "whether the link is on. "
502 "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
503 ".. code-block:: python\n\n"
508 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
509 "the list. Set it to -1 to not loop over.")
511 .def("turn_on", &Link::turn_on, py::call_guard<py::gil_scoped_release>(), "Turns the link on.")
512 .def("turn_off", &Link::turn_off, py::call_guard<py::gil_scoped_release>(), "Turns the link off.")
513 .def("is_on", &Link::is_on, "Check whether the link is on.")
515 .def("set_sharing_policy", &Link::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
516 "Set sharing policy for this link")
517 .def("set_concurrency_limit", &Link::set_concurrency_limit, py::call_guard<py::gil_scoped_release>(),
518 "Set concurrency limit for this link")
519 .def("set_host_wifi_rate", &Link::set_host_wifi_rate, py::call_guard<py::gil_scoped_release>(),
520 "Set level of communication speed of given host on this Wi-Fi link")
521 .def_static("by_name", &Link::by_name, "Retrieves a Link from its name, or dies")
522 .def("seal", &Link::seal, py::call_guard<py::gil_scoped_release>(), "Seal this link")
523 .def_property_readonly(
525 [](const Link* self) {
526 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
528 "The name of this link")
529 .def_property_readonly("bandwidth", &Link::get_bandwidth,
530 "The bandwidth (in bytes per second) (read-only property).")
531 .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property).");
533 py::enum_<Link::SharingPolicy>(link, "SharingPolicy")
534 .value("NONLINEAR", Link::SharingPolicy::NONLINEAR)
535 .value("WIFI", Link::SharingPolicy::WIFI)
536 .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX)
537 .value("SHARED", Link::SharingPolicy::SHARED)
538 .value("FATPIPE", Link::SharingPolicy::FATPIPE)
541 /* Class LinkInRoute */
542 py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
543 linkinroute.def(py::init<const Link*>());
544 linkinroute.def(py::init<const Link*, simgrid::s4u::LinkInRoute::Direction>());
545 py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
546 .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
547 .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
548 .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE)
551 /* Class Split-Duplex Link */
552 py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
553 m, "SplitDuplexLink", "Network split-duplex link")
554 .def("get_link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
555 .def("get_link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
558 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
559 m, "Mailbox", "Mailbox. See the C++ documentation for details.")
561 "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
562 "Textual representation of the Mailbox`")
563 .def("by_name", &Mailbox::by_name, py::call_guard<py::gil_scoped_release>(), "Retrieve a Mailbox from its name")
564 .def_property_readonly(
566 [](const Mailbox* self) {
567 return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
569 "The name of that mailbox (read-only property).")
572 [](Mailbox* self, py::object data, int size, double timeout) {
574 self->put(data.ptr(), size, timeout);
576 py::call_guard<py::gil_scoped_release>(), "Blocking data transmission with a timeout")
579 [](Mailbox* self, py::object data, int size) {
581 self->put(data.ptr(), size);
583 py::call_guard<py::gil_scoped_release>(), "Blocking data transmission")
586 [](Mailbox* self, py::object data, int size) {
588 return self->put_async(data.ptr(), size);
590 py::call_guard<py::gil_scoped_release>(), "Non-blocking data transmission")
594 py::object data = pybind11::reinterpret_steal<py::object>(self->get<PyObject>());
595 // data.dec_ref(); // FIXME: why does it break python-actor-create?
598 py::call_guard<py::gil_scoped_release>(), "Blocking data reception")
601 [](Mailbox* self) -> std::tuple<simgrid::s4u::CommPtr, PyGetAsync> {
603 auto comm = self->get_async(wrap.get());
604 return std::make_tuple(std::move(comm), std::move(wrap));
606 py::call_guard<py::gil_scoped_release>(),
607 "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
609 "set_receiver", [](Mailbox* self, ActorPtr actor) { self->set_receiver(actor); },
610 py::call_guard<py::gil_scoped_release>(), "Sets the actor as permanent receiver");
612 /* Class PyGetAsync */
613 py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
616 "get", [](const PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
617 "Get python object after async communication in receiver side");
620 py::class_<simgrid::s4u::Comm, simgrid::s4u::CommPtr>(m, "Comm",
621 "Communication. See the C++ documentation for details.")
622 .def("test", &simgrid::s4u::Comm::test, py::call_guard<py::gil_scoped_release>(),
623 "Test whether the communication is terminated.")
624 .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<py::gil_scoped_release>(),
625 "Block until the completion of that communication.")
626 // use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
628 "wait_all", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
629 py::call_guard<py::gil_scoped_release>(), "Block until the completion of all communications in the list.")
631 "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
632 py::call_guard<py::gil_scoped_release>(),
633 "Block until the completion of any communication in the list and return the index of the terminated one.");
636 py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities. See the C++ documentation for details.")
637 .def("test", &simgrid::s4u::Io::test, py::call_guard<py::gil_scoped_release>(),
638 "Test whether the I/O is terminated.")
639 .def("wait", &simgrid::s4u::Io::wait, py::call_guard<py::gil_scoped_release>(),
640 "Block until the completion of that I/O operation")
642 "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard<py::gil_scoped_release>(),
643 "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.")
644 .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard<py::gil_scoped_release>(),
645 "Block until the completion of any I/O in the list and return the index of the terminated one.");
648 py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution. See the C++ documentation for details.")
649 .def_property_readonly(
651 [](simgrid::s4u::ExecPtr self) {
652 py::gil_scoped_release gil_guard;
653 return self->get_remaining();
655 "Amount of flops that remain to be computed until completion (read-only property).")
656 .def_property_readonly(
658 [](simgrid::s4u::ExecPtr self) {
659 py::gil_scoped_release gil_guard;
660 return self->get_remaining_ratio();
662 "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
663 "yet) (read-only property).")
664 .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
665 "Host on which this execution runs. Only the first host is returned for parallel executions. "
666 "Changing this value migrates the execution.")
667 .def("test", &simgrid::s4u::Exec::test, py::call_guard<py::gil_scoped_release>(),
668 "Test whether the execution is terminated.")
669 .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<py::gil_scoped_release>(), "Cancel that execution.")
670 .def("start", &simgrid::s4u::Exec::start, py::call_guard<py::gil_scoped_release>(), "Start that execution.")
671 .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<py::gil_scoped_release>(),
672 "Block until the completion of that execution.");
675 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
676 "An actor is an independent stream of execution in your distributed "
677 "application. See the C++ documentation for details.")
680 [](py::str name, Host* h, py::object fun, py::args args) {
681 fun.inc_ref(); // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
682 args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
683 return simgrid::s4u::Actor::create(name, h, [fun, args]() {
685 py::gil_scoped_acquire py_context;
687 } catch (const py::error_already_set& ex) {
688 if (ex.matches(pyForcefulKillEx)) {
689 XBT_VERB("Actor killed");
690 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
696 py::call_guard<py::gil_scoped_release>(),
697 "Create an actor from a function or an object. See the :ref:`example <s4u_ex_actors_create>`.")
699 "host", &Actor::get_host,
700 [](Actor* a, Host* h) {
701 py::gil_scoped_release gil_guard;
704 "The host on which this actor is located. Changing this value migrates the actor.\n\n"
705 "If the actor is currently blocked on an execution activity, the activity is also migrated to the new host. "
706 "If it’s blocked on another kind of activity, an error is raised as the mandated code is not written yet. "
707 "Please report that bug if you need it.\n\n"
708 "Asynchronous activities started by the actor are not migrated automatically, so you have to take care of "
709 "this yourself (only you knows which ones should be migrated). ")
710 .def_property_readonly("name", &Actor::get_cname, "The name of this actor (read-only property).")
711 .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).")
712 .def_property_readonly("ppid", &Actor::get_ppid,
713 "The PID (unique identifier) of the actor that created this one (read-only property).")
714 .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
715 .def("set_auto_restart", &Actor::set_auto_restart, py::call_guard<py::gil_scoped_release>(),
716 "Specify whether the actor shall restart when its host reboots.")
717 .def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
718 "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
720 .def("is_daemon", &Actor::is_daemon,
721 "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
723 .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
724 "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
725 .def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
726 .def("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "Kill all actors but the caller.")
727 .def("self", &Actor::self, "Retrieves the current actor.")
728 .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
729 .def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
730 "Suspend that actor, that is blocked until resume()ed by another actor.")
731 .def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
732 "Resume that actor, that was previously suspend()ed.");