1 /* Copyright (c) 2018-2023. 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. */
6 #include <pybind11/pybind11.h> // Must come before our own stuff
8 #include <pybind11/functional.h>
9 #include <pybind11/stl.h>
11 #include "simgrid/kernel/ProfileBuilder.hpp"
12 #include "simgrid/kernel/routing/NetPoint.hpp"
13 #include <simgrid/Exception.hpp>
14 #include <simgrid/s4u/Actor.hpp>
15 #include <simgrid/s4u/Barrier.hpp>
16 #include <simgrid/s4u/Comm.hpp>
17 #include <simgrid/s4u/Disk.hpp>
18 #include <simgrid/s4u/Engine.hpp>
19 #include <simgrid/s4u/Exec.hpp>
20 #include <simgrid/s4u/Host.hpp>
21 #include <simgrid/s4u/Io.hpp>
22 #include <simgrid/s4u/Link.hpp>
23 #include <simgrid/s4u/Mailbox.hpp>
24 #include <simgrid/s4u/Mutex.hpp>
25 #include <simgrid/s4u/NetZone.hpp>
26 #include <simgrid/s4u/Semaphore.hpp>
27 #include <simgrid/s4u/Task.hpp>
28 #include <simgrid/version.h>
35 namespace py = pybind11;
36 using simgrid::s4u::CommTask;
37 using simgrid::s4u::CommTaskPtr;
38 using simgrid::s4u::ExecTask;
39 using simgrid::s4u::ExecTaskPtr;
40 using simgrid::s4u::IoTask;
41 using simgrid::s4u::IoTaskPtr;
42 using simgrid::s4u::Task;
43 using simgrid::s4u::TaskPtr;
44 using simgrid::s4u::Actor;
45 using simgrid::s4u::ActorPtr;
46 using simgrid::s4u::Barrier;
47 using simgrid::s4u::BarrierPtr;
48 using simgrid::s4u::Comm;
49 using simgrid::s4u::CommPtr;
50 using simgrid::s4u::Disk;
51 using simgrid::s4u::Engine;
52 using simgrid::s4u::Host;
53 using simgrid::s4u::Io;
54 using simgrid::s4u::Link;
55 using simgrid::s4u::Mailbox;
56 using simgrid::s4u::Mutex;
57 using simgrid::s4u::MutexPtr;
58 using simgrid::s4u::Semaphore;
59 using simgrid::s4u::SemaphorePtr;
61 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
65 std::string get_simgrid_version()
70 sg_version_get(&major, &minor, &patch);
71 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
74 /** @brief Wrap for mailbox::get_async */
76 std::unique_ptr<PyObject*> data = std::make_unique<PyObject*>();
79 PyObject** get() const { return data.get(); }
84 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
86 PYBIND11_MODULE(simgrid, m)
88 m.doc() = "SimGrid userspace API";
90 m.attr("simgrid_version") = get_simgrid_version();
92 // Swapped contexts are broken, starting from pybind11 v2.8.0. Use thread contexts by default.
93 simgrid::s4u::Engine::set_config("contexts/factory:thread");
95 // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
96 static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
98 py::register_exception<simgrid::NetworkFailureException>(m, "NetworkFailureException");
99 py::register_exception<simgrid::TimeoutException>(m, "TimeoutException");
100 py::register_exception<simgrid::HostFailureException>(m, "HostFailureException");
101 py::register_exception<simgrid::StorageFailureException>(m, "StorageFailureException");
102 py::register_exception<simgrid::VmFailureException>(m, "VmFailureException");
103 py::register_exception<simgrid::CancelException>(m, "CancelException");
104 py::register_exception<simgrid::AssertionError>(m, "AssertionError");
106 /* this_actor namespace */
107 m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.")
109 "debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.")
111 "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
113 "warning", [](const char* s) { XBT_WARN("%s", s); }, "Display a logging message of 'warning' priority.")
115 "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
116 .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
117 py::call_guard<py::gil_scoped_release>(),
118 "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
119 py::arg("priority") = 1)
120 .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
121 py::call_guard<py::gil_scoped_release>())
122 .def("exec_async", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_async),
123 py::call_guard<py::gil_scoped_release>())
124 .def("parallel_execute", &simgrid::s4u::this_actor::parallel_execute, py::call_guard<py::gil_scoped_release>(),
125 "Run a parallel task (requires the 'ptask_L07' model)")
127 py::overload_cast<const std::vector<simgrid::s4u::Host*>&, const std::vector<double>&,
128 const std::vector<double>&>(&simgrid::s4u::this_actor::exec_init),
129 py::call_guard<py::gil_scoped_release>(), "Initiate a parallel task (requires the 'ptask_L07' model)")
130 .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
131 .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<py::gil_scoped_release>(),
132 "Moves the current actor to another host.", py::arg("dest"))
133 .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
134 py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping for that amount of seconds.",
136 .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
137 py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping until the specified timestamp.",
139 .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<py::gil_scoped_release>(),
140 "Suspend the current actor, that is blocked until resume()ed by another actor.")
141 .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<py::gil_scoped_release>(), "Yield the actor")
142 .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<py::gil_scoped_release>(), "kill the current actor")
146 fun.inc_ref(); // keep alive after return
147 const py::gil_scoped_release gil_release;
148 simgrid::s4u::this_actor::on_exit([fun_p = fun.ptr()](bool failed) {
149 const py::gil_scoped_acquire py_context; // need a new context for callback
151 const auto fun = py::reinterpret_borrow<py::function>(fun_p);
153 } catch (const py::error_already_set& e) {
154 xbt_die("Error while executing the on_exit lambda: %s", e.what());
158 "Define a lambda to be called when the actor ends. It takes a bool parameter indicating whether the actor "
159 "was killed. If False, the actor finished peacefully.")
160 .def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
161 .def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
162 "Retrieves PPID of the current actor (i.e., the PID of its parent).");
165 py::class_<Engine>(m, "Engine", "Simulation Engine")
166 .def(py::init([](std::vector<std::string> args) {
167 auto argc = static_cast<int>(args.size());
168 std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
169 std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
170 // Currently this can be dangling, we should wrap this somehow.
171 return new simgrid::s4u::Engine(&argc, argv.data());
173 "The constructor should take the parameters from the command line, as is ")
174 .def_static("get_clock",
175 []() // XBT_ATTRIB_DEPRECATED_v334
178 PyExc_DeprecationWarning,
179 "get_clock() is deprecated and will be dropped after v3.33, use `Engine.clock` instead.", 1);
180 return Engine::get_clock();
182 .def_property_readonly_static(
183 "clock", [](py::object /* self */) { return Engine::get_clock(); },
184 "The simulation time, ie the amount of simulated seconds since the simulation start.")
185 .def_property_readonly_static(
186 "instance", [](py::object /* self */) { return Engine::get_instance(); }, "Retrieve the simulation engine")
187 .def("get_all_hosts",
188 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
190 PyErr_WarnEx(PyExc_DeprecationWarning,
191 "get_all_hosts() is deprecated and will be dropped after v3.33, use all_hosts instead.", 1);
192 return self.attr("all_hosts");
194 .def("host_by_name", &Engine::host_by_name_or_null,
195 "Retrieve a host by its name, or None if it does not exist in the platform.")
196 .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
197 .def("get_all_links",
198 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
200 PyErr_WarnEx(PyExc_DeprecationWarning,
201 "get_all_links() is deprecated and will be dropped after v3.33, use all_links instead.", 1);
202 return self.attr("all_links");
204 .def_property_readonly("all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
205 .def("get_all_netpoints",
206 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
209 PyExc_DeprecationWarning,
210 "get_all_netpoints() is deprecated and will be dropped after v3.33, use all_netpoints instead.", 1);
211 return self.attr("all_netpoints");
213 .def_property_readonly("all_netpoints", &Engine::get_all_netpoints)
214 .def("get_netzone_root",
215 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
218 PyExc_DeprecationWarning,
219 "get_netzone_root() is deprecated and will be dropped after v3.33, use netzone_root instead.", 1);
220 return self.attr("netzone_root");
222 .def_property_readonly("netzone_root", &Engine::get_netzone_root,
223 "Retrieve the root netzone, containing all others.")
224 .def("netpoint_by_name", &Engine::netpoint_by_name_or_null)
225 .def("netzone_by_name", &Engine::netzone_by_name_or_null)
226 .def("set_config", py::overload_cast<const std::string&>(&Engine::set_config),
227 "Change one of SimGrid's configurations")
228 .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
229 .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
230 .def("mailbox_by_name_or_create", &Engine::mailbox_by_name_or_create, py::call_guard<py::gil_scoped_release>(),
231 py::arg("name"), "Find a mailbox from its name or create one if it does not exist")
232 .def("run", &Engine::run, py::call_guard<py::gil_scoped_release>(), "Run the simulation until its end")
233 .def("run_until", py::overload_cast<double>(&Engine::run_until, py::const_),
234 py::call_guard<py::gil_scoped_release>(), "Run the simulation until the given date",
235 py::arg("max_date") = -1)
238 [](Engine* e, const std::string& name, py::object fun_or_class) {
239 fun_or_class.inc_ref(); // keep alive after return
240 const py::gil_scoped_release gil_release;
241 e->register_actor(name, [fun_or_class_p = fun_or_class.ptr()](std::vector<std::string> args) {
242 const py::gil_scoped_acquire py_context;
244 /* Convert the std::vector into a py::tuple */
245 py::tuple params(args.size() - 1);
246 for (size_t i = 1; i < args.size(); i++)
247 params[i - 1] = py::cast(args[i]);
249 const auto fun_or_class = py::reinterpret_borrow<py::object>(fun_or_class_p);
250 py::object res = fun_or_class(*params);
251 /* If I was passed a class, I just built an instance, so I need to call it now */
252 if (py::isinstance<py::function>(res))
254 } catch (const py::error_already_set& ex) {
255 if (ex.matches(pyForcefulKillEx)) {
256 XBT_VERB("Actor killed");
257 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
263 "Registers the main function of an actor");
266 py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>> netzone(
267 m, "NetZone", "Networking Zones. See the C++ documentation for details.");
268 netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
269 .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
270 .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
271 .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
272 .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
273 .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd")
274 .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra")
275 .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi")
276 .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty")
277 .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi")
279 py::overload_cast<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
280 simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*,
281 const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
282 "Add a route between 2 netpoints")
283 .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
286 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
289 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
292 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
294 .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
295 "Creates a network link")
297 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
298 "Creates a network link")
300 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
301 "Creates a network link")
303 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
304 "Creates a network link")
305 .def("create_split_duplex_link",
306 py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
307 "Creates a split-duplex link")
308 .def("create_split_duplex_link",
309 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
310 "Creates a split-duplex link")
311 .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
312 .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
313 .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
315 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
317 PyErr_WarnEx(PyExc_DeprecationWarning,
318 "get_netpoint() is deprecated and will be dropped after v3.33, use netpoint instead.", 1);
319 return self.attr("netpoint");
321 .def_property_readonly("netpoint", &simgrid::s4u::NetZone::get_netpoint,
322 "Retrieve the netpoint associated to this zone")
323 .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
324 .def_property_readonly("name", &simgrid::s4u::NetZone::get_name,
325 "The name of this network zone (read-only property).")
327 "__repr__", [](const simgrid::s4u::NetZone net) { return "NetZone(" + net.get_name() + ")"; },
328 "Textual representation of the NetZone");
330 /* Class ClusterCallbacks */
331 py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
332 .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetPointCb>&,
333 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
334 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
336 /* Class FatTreeParams */
337 py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
338 .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
339 const std::vector<unsigned int>&>());
341 /* Class DragonflyParams */
342 py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
343 .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
344 const std::pair<unsigned int, unsigned int>&, unsigned int>());
347 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
348 m, "Host", "Simulated host. See the C++ documentation for details.");
349 host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die")
352 [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
353 auto* list = new std::vector<Link*>();
355 h->route_to(to, *list, &bw);
356 return make_tuple(list, bw);
358 "Retrieves the list of links and the bandwidth between two hosts.")
361 [](Host* h, const std::string& profile, double period) {
362 h->set_speed_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
364 py::call_guard<py::gil_scoped_release>(),
365 "Specify a profile modeling the external load according to an exhaustive list. "
366 "Each line of the profile describes timed events as ``date ratio``. "
367 "For example, the following content describes an host which computational speed is initially 1 (i.e, 100%) "
368 "and then halved after 42 seconds:\n\n"
369 ".. code-block:: python\n\n"
374 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
375 " while speed profiles of hosts contain ratios.\n\n"
376 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
377 "the list. Set it to -1 to not loop over.")
380 [](Host* h, const std::string& profile, double period) {
381 h->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
383 py::call_guard<py::gil_scoped_release>(),
384 "Specify a profile modeling the churn. "
385 "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
386 "whether the host is on. "
387 "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
388 ".. code-block:: python\n\n"
393 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
394 "the list. Set it to -1 to not loop over.")
395 .def("get_pstate_count",
396 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
399 PyExc_DeprecationWarning,
400 "get_pstate_count() is deprecated and will be dropped after v3.33, use pstate_count instead.", 1);
401 return self.attr("pstate_count");
403 .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
404 .def("get_pstate_speed",
405 [](py::object self, int state) // XBT_ATTRIB_DEPRECATED_v334
408 PyExc_DeprecationWarning,
409 "get_pstate_speed() is deprecated and will be dropped after v3.33, use pstate_speed instead.", 1);
410 return self.attr("pstate_speed")(state);
412 .def("pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
414 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
416 PyErr_WarnEx(PyExc_DeprecationWarning,
417 "get_netpoint() is deprecated and will be dropped after v3.33, use netpoint instead.", 1);
418 return self.attr("netpoint");
420 .def_property_readonly("netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this zone")
421 .def_property_readonly("disks", &Host::get_disks, "The list of disks on this host (read-only).")
422 .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
423 .def("set_core_count",
424 [](py::object self, double count) // XBT_ATTRIB_DEPRECATED_v334
426 PyErr_WarnEx(PyExc_DeprecationWarning,
427 "set_core_count() is deprecated and will be dropped after v3.33, use core_count instead.",
429 self.attr("core_count")(count);
431 .def_property("core_count", &Host::get_core_count,
432 py::cpp_function(&Host::set_core_count, py::call_guard<py::gil_scoped_release>()),
433 "Manage the number of cores in the CPU")
434 .def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
435 "Set the coordinates of this host")
436 .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
437 "Describe how the CPU is shared", py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
438 .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk),
439 py::call_guard<py::gil_scoped_release>(), "Create a disk")
441 py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
442 py::call_guard<py::gil_scoped_release>(), "Create a disk")
443 .def("seal", &Host::seal, py::call_guard<py::gil_scoped_release>(), "Seal this host")
444 .def_property("pstate", &Host::get_pstate,
445 py::cpp_function(&Host::set_pstate, py::call_guard<py::gil_scoped_release>()),
446 "The current pstate (read/write property).")
447 .def_static("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
448 "Retrieves the host on which the running actor is located.")
449 .def_property_readonly("name", &Host::get_name, "The name of this host (read-only property).")
450 .def_property_readonly("load", &Host::get_load,
451 "Returns the current computation load (in flops per second), NOT taking the external load "
452 "into account. This is the currently achieved speed (read-only property).")
453 .def_property_readonly(
454 "speed", &Host::get_speed,
455 "The peak computing speed in flops/s at the current pstate, NOT taking the external load into account. "
456 "This is the max potential speed (read-only property).")
457 .def_property_readonly("available_speed", &Host::get_available_speed,
458 "Get the available speed ratio, between 0 and 1.\n"
459 "This accounts for external load (see :py:func:`set_speed_profile() "
460 "<simgrid.Host.set_speed_profile>`) (read-only property).")
464 cb.inc_ref(); // keep alive after return
465 const py::gil_scoped_release gil_release;
466 Host::on_creation_cb([cb_p = cb.ptr()](Host& h) {
467 const py::gil_scoped_acquire py_context; // need a new context for callback
469 const auto fun = py::reinterpret_borrow<py::function>(cb_p);
471 } catch (const py::error_already_set& e) {
472 xbt_die("Error while executing the on_creation lambda : %s", e.what());
478 "__repr__", [](const Host* h) { return "Host(" + h->get_name() + ")"; },
479 "Textual representation of the Host");
481 py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
482 .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
483 .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR)
487 py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(
488 m, "Disk", "Simulated disk. See the C++ documentation for details.");
489 disk.def("read", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::read, py::const_),
490 py::call_guard<py::gil_scoped_release>(), "Read data from disk", py::arg("size"), py::arg("priority") = 1)
491 .def("write", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::write, py::const_),
492 py::call_guard<py::gil_scoped_release>(), "Write data in disk", py::arg("size"), py::arg("priority") = 1)
493 .def("read_async", &simgrid::s4u::Disk::read_async, py::call_guard<py::gil_scoped_release>(),
494 "Non-blocking read data from disk")
495 .def("write_async", &simgrid::s4u::Disk::write_async, py::call_guard<py::gil_scoped_release>(),
496 "Non-blocking write data in disk")
497 .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
498 "Set sharing policy for this disk", py::arg("op"), py::arg("policy"),
499 py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
500 .def("seal", &simgrid::s4u::Disk::seal, py::call_guard<py::gil_scoped_release>(), "Seal this disk")
501 .def_property_readonly("name", &simgrid::s4u::Disk::get_name, "The name of this disk (read-only property).")
503 "__repr__", [](const Disk* d) { return "Disk(" + d->get_name() + ")"; },
504 "Textual representation of the Disk");
505 py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
506 .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
507 .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR)
509 py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
510 .value("READ", simgrid::s4u::Disk::Operation::READ)
511 .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
512 .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE)
516 py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
517 netpoint(m, "NetPoint", "NetPoint object");
520 py::class_<Link, std::unique_ptr<Link, py::nodelete>> link(m, "Link",
521 "Network link. See the C++ documentation for details.");
522 link.def("set_latency", py::overload_cast<const std::string&>(&Link::set_latency),
523 py::call_guard<py::gil_scoped_release>(),
524 "Set the latency as a string. Accepts values with units, such as ‘1s’ or ‘7ms’.\nFull list of accepted "
525 "units: w (week), d (day), h, s, ms, us, ns, ps.")
526 .def("set_latency", py::overload_cast<double>(&Link::set_latency), py::call_guard<py::gil_scoped_release>(),
527 "Set the latency as a float (in seconds).")
528 .def("set_bandwidth", &Link::set_bandwidth, py::call_guard<py::gil_scoped_release>(),
529 "Set the bandwidth (in byte per second).")
531 "set_bandwidth_profile",
532 [](Link* l, const std::string& profile, double period) {
533 l->set_bandwidth_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
535 py::call_guard<py::gil_scoped_release>(),
536 "Specify a profile modeling the external load according to an exhaustive list. "
537 "Each line of the profile describes timed events as ``date bandwidth`` (in bytes per second). "
538 "For example, the following content describes a link which bandwidth changes to 40 Mb/s at t=4, and to 6 "
540 ".. code-block:: python\n\n"
545 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
546 " while speed profiles of hosts contain ratios.\n\n"
547 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
548 "the list. Set it to -1 to not loop over.")
550 "set_latency_profile",
551 [](Link* l, const std::string& profile, double period) {
552 l->set_latency_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
554 py::call_guard<py::gil_scoped_release>(),
555 "Specify a profile modeling the external load according to an exhaustive list. "
556 "Each line of the profile describes timed events as ``date latency`` (in seconds). "
557 "For example, the following content describes a link which latency changes to 1ms (0.001s) at t=1, and to 2s "
559 ".. code-block:: python\n\n"
564 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
565 " while speed profiles of hosts contain ratios.\n\n"
566 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
567 "the list. Set it to -1 to not loop over.")
570 [](Link* l, const std::string& profile, double period) {
571 l->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
573 "Specify a profile modeling the churn. "
574 "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
575 "whether the link is on. "
576 "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
577 ".. code-block:: python\n\n"
582 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
583 "the list. Set it to -1 to not loop over.")
585 .def("turn_on", &Link::turn_on, py::call_guard<py::gil_scoped_release>(), "Turns the link on.")
586 .def("turn_off", &Link::turn_off, py::call_guard<py::gil_scoped_release>(), "Turns the link off.")
587 .def("is_on", &Link::is_on, "Check whether the link is on.")
589 .def("set_sharing_policy", &Link::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
590 "Set sharing policy for this link")
591 .def("set_concurrency_limit", &Link::set_concurrency_limit, py::call_guard<py::gil_scoped_release>(),
592 "Set concurrency limit for this link")
593 .def("set_host_wifi_rate", &Link::set_host_wifi_rate, py::call_guard<py::gil_scoped_release>(),
594 "Set level of communication speed of given host on this Wi-Fi link")
595 .def_static("by_name", &Link::by_name, "Retrieves a Link from its name, or dies")
596 .def("seal", &Link::seal, py::call_guard<py::gil_scoped_release>(), "Seal this link")
597 .def_property_readonly("name", &Link::get_name, "The name of this link")
598 .def_property_readonly("bandwidth", &Link::get_bandwidth,
599 "The bandwidth (in bytes per second) (read-only property).")
600 .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property).")
602 "__repr__", [](const Link* l) { return "Link(" + l->get_name() + ")"; },
603 "Textual representation of the Link");
604 py::enum_<Link::SharingPolicy>(link, "SharingPolicy")
605 .value("NONLINEAR", Link::SharingPolicy::NONLINEAR)
606 .value("WIFI", Link::SharingPolicy::WIFI)
607 .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX)
608 .value("SHARED", Link::SharingPolicy::SHARED)
609 .value("FATPIPE", Link::SharingPolicy::FATPIPE)
612 /* Class LinkInRoute */
613 py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
614 linkinroute.def(py::init<const Link*>());
615 linkinroute.def(py::init<const Link*, simgrid::s4u::LinkInRoute::Direction>());
616 py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
617 .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
618 .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
619 .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE)
622 /* Class Split-Duplex Link */
623 py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
624 m, "SplitDuplexLink", "Network split-duplex link")
626 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
628 PyErr_WarnEx(PyExc_DeprecationWarning,
629 "get_link_up() is deprecated and will be dropped after v3.33, use link_up instead.", 1);
630 return self.attr("link_up");
632 .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
633 .def("get_link_down",
634 [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
636 PyErr_WarnEx(PyExc_DeprecationWarning,
637 "get_link_down() is deprecated and will be dropped after v3.33, use link_down instead.", 1);
638 return self.attr("link_down");
640 .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
643 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
644 m, "Mailbox", "Mailbox. See the C++ documentation for details.")
646 "__repr__", [](const Mailbox* self) { return "Mailbox(" + self->get_name() + ")"; },
647 "Textual representation of the Mailbox")
648 .def_static("by_name", &Mailbox::by_name, py::call_guard<py::gil_scoped_release>(), py::arg("name"),
649 "Retrieve a Mailbox from its name")
650 .def_property_readonly("name", &Mailbox::get_name, "The name of that mailbox (read-only property).")
651 .def_property_readonly("ready", &Mailbox::ready,
652 "Check if there is a communication ready to be consumed from a mailbox.")
655 [](Mailbox* self, py::object data, uint64_t size, double timeout) {
656 auto* data_ptr = data.inc_ref().ptr();
657 const py::gil_scoped_release gil_release;
658 self->put(data_ptr, size, timeout);
660 "Blocking data transmission with a timeout")
663 [](Mailbox* self, py::object data, uint64_t size) {
664 auto* data_ptr = data.inc_ref().ptr();
665 const py::gil_scoped_release gil_release;
666 self->put(data_ptr, size);
668 "Blocking data transmission")
671 [](Mailbox* self, py::object data, uint64_t size) {
672 auto* data_ptr = data.inc_ref().ptr();
673 const py::gil_scoped_release gil_release;
674 return self->put_async(data_ptr, size);
676 "Non-blocking data transmission")
679 [](Mailbox* self, py::object data, uint64_t size) {
680 auto* data_ptr = data.inc_ref().ptr();
681 const py::gil_scoped_release gil_release;
682 return self->put_init(data_ptr, size);
684 "Creates (but don’t start) a data transmission to that mailbox.")
686 "get", [](Mailbox* self) { return py::reinterpret_steal<py::object>(self->get<PyObject>()); },
687 py::call_guard<py::gil_scoped_release>(), "Blocking data reception")
690 [](Mailbox* self) -> std::tuple<CommPtr, PyGetAsync> {
692 auto comm = self->get_async(wrap.get());
693 return std::make_tuple(std::move(comm), std::move(wrap));
695 py::call_guard<py::gil_scoped_release>(),
696 "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
697 .def("set_receiver", &Mailbox::set_receiver, py::call_guard<py::gil_scoped_release>(),
698 "Sets the actor as permanent receiver");
700 /* Class PyGetAsync */
701 py::class_<PyGetAsync>(m, "PyGetAsync", "Wrapper for async get communications")
704 "get", [](const PyGetAsync* self) { return py::reinterpret_steal<py::object>(*(self->get())); },
705 "Get python object after async communication in receiver side");
708 py::class_<Comm, CommPtr>(m, "Comm", "Communication. See the C++ documentation for details.")
709 .def_property_readonly("dst_data_size", &Comm::get_dst_data_size, py::call_guard<py::gil_scoped_release>(),
710 "Retrieve the size of the received data.")
711 .def_property_readonly("mailbox", &Comm::get_mailbox, py::call_guard<py::gil_scoped_release>(),
712 "Retrieve the mailbox on which this comm acts.")
713 .def_property_readonly("sender", &Comm::get_sender, py::call_guard<py::gil_scoped_release>())
714 .def_property_readonly("state_str", &Comm::get_state_str, py::call_guard<py::gil_scoped_release>(),
715 "Retrieve the Comm state as string")
716 .def_property_readonly("remaining", &Comm::get_remaining, py::call_guard<py::gil_scoped_release>(),
717 "Remaining amount of work that this Comm entails")
718 .def_property_readonly("start_time", &Comm::get_start_time, py::call_guard<py::gil_scoped_release>(),
719 "Time at which this Comm started")
720 .def_property_readonly("finish_time", &Comm::get_finish_time, py::call_guard<py::gil_scoped_release>(),
721 "Time at which this Comm finished")
722 .def_property_readonly("is_suspended", &Comm::is_suspended, py::call_guard<py::gil_scoped_release>(),
723 "Whether this Comm is suspended")
724 .def("set_payload_size", &Comm::set_payload_size, py::call_guard<py::gil_scoped_release>(), py::arg("bytes"),
725 "Specify the amount of bytes which exchange should be simulated.")
726 .def("set_rate", &Comm::set_rate, py::call_guard<py::gil_scoped_release>(), py::arg("rate"),
727 "Sets the maximal communication rate (in byte/sec). Must be done before start")
728 .def("cancel", &Comm::cancel, py::call_guard<py::gil_scoped_release>(),
729 py::return_value_policy::reference_internal, "Cancel the activity.")
730 .def("start", &Comm::start, py::call_guard<py::gil_scoped_release>(), py::return_value_policy::reference_internal,
731 "Starts a previously created activity. This function is optional: you can call wait() even if you didn't "
733 .def("suspend", &Comm::suspend, py::call_guard<py::gil_scoped_release>(),
734 py::return_value_policy::reference_internal, "Suspend the activity.")
735 .def("resume", &Comm::resume, py::call_guard<py::gil_scoped_release>(),
736 py::return_value_policy::reference_internal, "Resume the activity.")
737 .def("test", &Comm::test, py::call_guard<py::gil_scoped_release>(),
738 "Test whether the communication is terminated.")
739 .def("wait", &Comm::wait, py::call_guard<py::gil_scoped_release>(),
740 "Block until the completion of that communication.")
741 .def("wait_for", &Comm::wait_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
742 "Block until the completion of that communication, or raises TimeoutException after the specified timeout.")
743 .def("wait_until", &Comm::wait_until, py::call_guard<py::gil_scoped_release>(), py::arg("time_limit"),
744 "Block until the completion of that communication, or raises TimeoutException after the specified time.")
745 .def("detach", py::overload_cast<>(&Comm::detach), py::return_value_policy::reference_internal,
746 py::call_guard<py::gil_scoped_release>(),
747 "Start the comm, and ignore its result. It can be completely forgotten after that.")
748 .def_static("sendto", &Comm::sendto, py::call_guard<py::gil_scoped_release>(), py::arg("from"), py::arg("to"),
749 py::arg("simulated_size_in_bytes"), "Do a blocking communication between two arbitrary hosts.")
750 .def_static("sendto_init", py::overload_cast<Host*, Host*>(&Comm::sendto_init),
751 py::call_guard<py::gil_scoped_release>(), py::arg("from"), py::arg("to"),
752 "Creates a communication between the two given hosts, bypassing the mailbox mechanism.")
753 .def_static("sendto_async", &Comm::sendto_async, py::call_guard<py::gil_scoped_release>(), py::arg("from"),
754 py::arg("to"), py::arg("simulated_size_in_bytes"),
755 "Do a blocking communication between two arbitrary hosts.\n\nThis initializes a communication that "
756 "completely bypass the mailbox and actors mechanism. There is really no limit on the hosts involved. "
757 "In particular, the actor does not have to be on one of the involved hosts.")
758 .def_static("test_any", &Comm::test_any, py::call_guard<py::gil_scoped_release>(), py::arg("comms"),
759 "take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done)")
760 .def_static("wait_all", &Comm::wait_all, py::call_guard<py::gil_scoped_release>(), py::arg("comms"),
761 "Block until the completion of all communications in the list.")
762 .def_static("wait_all_for", &Comm::wait_all_for, py::call_guard<py::gil_scoped_release>(), py::arg("comms"),
764 "Block until the completion of all communications in the list, or raises TimeoutException after "
765 "the specified timeout.")
766 .def_static("wait_any", &Comm::wait_any, py::call_guard<py::gil_scoped_release>(), py::arg("comms"),
767 "Block until the completion of any communication in the list and return the index of the "
769 .def_static("wait_any_for", &Comm::wait_any_for, py::call_guard<py::gil_scoped_release>(), py::arg("comms"),
771 "Block until the completion of any communication in the list and return the index of the terminated "
772 "one, or -1 if a timeout occurred.");
775 py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr>(m, "Io", "I/O activities. See the C++ documentation for details.")
776 .def("test", &simgrid::s4u::Io::test, py::call_guard<py::gil_scoped_release>(),
777 "Test whether the I/O is terminated.")
778 .def("wait", &simgrid::s4u::Io::wait, py::call_guard<py::gil_scoped_release>(),
779 "Block until the completion of that I/O operation")
781 "wait_any_for", &simgrid::s4u::Io::wait_any_for, py::call_guard<py::gil_scoped_release>(),
782 "Block until the completion of any I/O in the list (or timeout) and return the index of the terminated one.")
783 .def_static("wait_any", &simgrid::s4u::Io::wait_any, py::call_guard<py::gil_scoped_release>(),
784 "Block until the completion of any I/O in the list and return the index of the terminated one.");
787 py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr>(m, "Exec", "Execution. See the C++ documentation for details.")
788 .def_property_readonly("remaining", &simgrid::s4u::Exec::get_remaining, py::call_guard<py::gil_scoped_release>(),
789 "Amount of flops that remain to be computed until completion (read-only property).")
790 .def_property_readonly("remaining_ratio", &simgrid::s4u::Exec::get_remaining_ratio,
791 py::call_guard<py::gil_scoped_release>(),
792 "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
793 "yet) (read-only property).")
794 .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
795 "Host on which this execution runs. Only the first host is returned for parallel executions. "
796 "Changing this value migrates the execution.")
797 .def_property_readonly("is_suspended", &simgrid::s4u::Exec::is_suspended,
798 py::call_guard<py::gil_scoped_release>(), "Whether this Exec is suspended")
799 .def("test", &simgrid::s4u::Exec::test, py::call_guard<py::gil_scoped_release>(),
800 "Test whether the execution is terminated.")
801 .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<py::gil_scoped_release>(), "Cancel that execution.")
802 .def("start", &simgrid::s4u::Exec::start, py::call_guard<py::gil_scoped_release>(), "Start that execution.")
803 .def("suspend", &simgrid::s4u::Exec::suspend, py::call_guard<py::gil_scoped_release>(), "Suspend that execution.")
804 .def("resume", &simgrid::s4u::Exec::resume, py::call_guard<py::gil_scoped_release>(), "Resume that execution.")
805 .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<py::gil_scoped_release>(),
806 "Block until the completion of that execution.")
807 .def("wait_for", &simgrid::s4u::Exec::wait_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
808 "Block until the completion of that activity, or raises TimeoutException after the specified timeout.");
810 /* Class Semaphore */
811 py::class_<Semaphore, SemaphorePtr>(m, "Semaphore",
812 "A classical semaphore, but blocking in the simulation world. See the C++ "
813 "documentation for details.")
814 .def(py::init<>(&Semaphore::create), py::call_guard<py::gil_scoped_release>(), py::arg("capacity"),
815 "Semaphore constructor.")
816 .def("acquire", &Semaphore::acquire, py::call_guard<py::gil_scoped_release>(),
817 "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired.")
818 .def("acquire_timeout", &Semaphore::acquire_timeout, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
819 "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired or return "
820 "true if it has not been acquired after the specified timeout.")
821 .def("release", &Semaphore::release, py::call_guard<py::gil_scoped_release>(), "Release the semaphore.")
822 .def_property_readonly("capacity", &Semaphore::get_capacity, py::call_guard<py::gil_scoped_release>(),
823 "Get the semaphore capacity.")
824 .def_property_readonly("would_block", &Semaphore::would_block, py::call_guard<py::gil_scoped_release>(),
825 "Check whether trying to acquire the semaphore would block (in other word, checks whether "
826 "this semaphore has capacity).")
827 // Allow semaphores to be automatically acquired/released with a context manager: `with semaphore: ...`
828 .def("__enter__", &Semaphore::acquire, py::call_guard<py::gil_scoped_release>())
830 [](Semaphore* self, const py::object&, const py::object&, const py::object&) { self->release(); });
833 py::class_<Mutex, MutexPtr>(m, "Mutex",
834 "A classical mutex, but blocking in the simulation world."
835 "See the C++ documentation for details.")
836 .def(py::init<>(&Mutex::create), py::call_guard<py::gil_scoped_release>(), "Mutex constructor.")
837 .def("lock", &Mutex::lock, py::call_guard<py::gil_scoped_release>(), "Block until the mutex is acquired.")
838 .def("try_lock", &Mutex::try_lock, py::call_guard<py::gil_scoped_release>(),
839 "Try to acquire the mutex. Return true if the mutex was acquired, false otherwise.")
840 .def("unlock", &Mutex::unlock, py::call_guard<py::gil_scoped_release>(), "Release the mutex.")
841 // Allow mutexes to be automatically acquired/released with a context manager: `with mutex: ...`
842 .def("__enter__", &Mutex::lock, py::call_guard<py::gil_scoped_release>())
844 "__exit__", [](Mutex* self, const py::object&, const py::object&, const py::object&) { self->unlock(); },
845 py::call_guard<py::gil_scoped_release>());
848 py::class_<Barrier, BarrierPtr>(m, "Barrier", "A classical barrier, but blocking in the simulation world.")
849 .def(py::init<>(&Barrier::create), py::call_guard<py::gil_scoped_release>(), py::arg("expected_actors"),
850 "Barrier constructor.")
851 .def("wait", &Barrier::wait, py::call_guard<py::gil_scoped_release>(),
852 "Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches "
856 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
857 "An actor is an independent stream of execution in your distributed "
858 "application. See the C++ documentation for details.")
861 [](const std::string& name, Host* h, py::object fun, py::args args) {
862 fun.inc_ref(); // keep alive after return
863 args.inc_ref(); // keep alive after return
864 const py::gil_scoped_release gil_release;
865 return simgrid::s4u::Actor::create(name, h, [fun_p = fun.ptr(), args_p = args.ptr()]() {
866 const py::gil_scoped_acquire py_context;
868 const auto fun = py::reinterpret_borrow<py::object>(fun_p);
869 const auto args = py::reinterpret_borrow<py::args>(args_p);
871 } catch (const py::error_already_set& ex) {
872 if (ex.matches(pyForcefulKillEx)) {
873 XBT_VERB("Actor killed");
874 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
880 "Create an actor from a function or an object. See the :ref:`example <s4u_ex_actors_create>`.")
882 "host", &Actor::get_host, py::cpp_function(&Actor::set_host, py::call_guard<py::gil_scoped_release>()),
883 "The host on which this actor is located. Changing this value migrates the actor.\n\n"
884 "If the actor is currently blocked on an execution activity, the activity is also migrated to the new host. "
885 "If it’s blocked on another kind of activity, an error is raised as the mandated code is not written yet. "
886 "Please report that bug if you need it.\n\n"
887 "Asynchronous activities started by the actor are not migrated automatically, so you have to take care of "
888 "this yourself (only you knows which ones should be migrated). ")
889 .def_property_readonly("name", &Actor::get_cname, "The name of this actor (read-only property).")
890 .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).")
891 .def_property_readonly("ppid", &Actor::get_ppid,
892 "The PID (unique identifier) of the actor that created this one (read-only property).")
893 .def_static("by_pid", &Actor::by_pid, py::arg("pid"), "Retrieve an actor by its PID")
894 .def("set_auto_restart", &Actor::set_auto_restart, py::call_guard<py::gil_scoped_release>(),
895 "Specify whether the actor shall restart when its host reboots.")
896 .def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
897 "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
899 .def("is_daemon", &Actor::is_daemon,
900 "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
902 .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
903 "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout") = -1)
904 .def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
905 .def("self", &Actor::self, "Retrieves the current actor.")
906 .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
907 .def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
908 "Suspend that actor, that is blocked until resume()ed by another actor.")
909 .def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
910 "Resume that actor, that was previously suspend()ed.")
911 .def_static("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(),
912 "Kill all actors but the caller.")
914 "__repr__", [](const ActorPtr a) { return "Actor(" + a->get_name() + ")"; },
915 "Textual representation of the Actor");
917 /* Enum Class IoOpType */
918 py::enum_<simgrid::s4u::Io::OpType>(m, "IoOpType")
919 .value("READ", simgrid::s4u::Io::OpType::READ)
920 .value("WRITE", simgrid::s4u::Io::OpType::WRITE);
923 py::class_<Task, TaskPtr>(m, "Task", "Task. See the C++ documentation for details.")
927 cb.inc_ref(); // keep alive after return
928 const py::gil_scoped_release gil_release;
929 Task::on_start_cb([cb_p = cb.ptr()](Task* op) {
930 const py::gil_scoped_acquire py_context; // need a new context for callback
931 py::reinterpret_borrow<py::function>(cb_p)(op);
934 "Add a callback called when each task starts.")
938 cb.inc_ref(); // keep alive after return
939 const py::gil_scoped_release gil_release;
940 Task::on_completion_cb([cb_p = cb.ptr()](Task* op) {
941 const py::gil_scoped_acquire py_context; // need a new context for callback
942 py::reinterpret_borrow<py::function>(cb_p)(op);
945 "Add a callback called when each task ends.")
946 .def_property_readonly("name", &Task::get_name, "The name of this task (read-only).")
947 .def_property_readonly("count", &Task::get_count, "The execution count of this task (read-only).")
948 .def_property_readonly("successors", &Task::get_successors, "The successors of this task (read-only).")
949 .def_property("amount", &Task::get_amount, &Task::set_amount, "The amount of work to do for this task.")
950 .def("enqueue_firings", py::overload_cast<int>(&Task::enqueue_firings), py::call_guard<py::gil_scoped_release>(),
951 py::arg("n"), "Enqueue firings for this task.")
952 .def("add_successor", py::overload_cast<TaskPtr>(&Task::add_successor), py::call_guard<py::gil_scoped_release>(),
953 py::arg("op"), "Add a successor to this task.")
954 .def("remove_successor", py::overload_cast<TaskPtr>(&Task::remove_successor),
955 py::call_guard<py::gil_scoped_release>(), py::arg("op"), "Remove a successor of this task.")
956 .def("remove_all_successors", &Task::remove_all_successors, py::call_guard<py::gil_scoped_release>(),
957 "Remove all successors of this task.")
958 .def("on_this_start_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_start_cb),
959 py::arg("func"), "Add a callback called when this task starts.")
960 .def("on_this_completion_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_completion_cb),
961 py::arg("func"), "Add a callback called when this task ends.")
963 "__repr__", [](const TaskPtr op) { return "Task(" + op->get_name() + ")"; },
964 "Textual representation of the Task");
967 py::class_<CommTask, CommTaskPtr, Task>(m, "CommTask", "Communication Task. See the C++ documentation for details.")
968 .def_static("init", py::overload_cast<const std::string&>(&CommTask::init),
969 py::call_guard<py::gil_scoped_release>(), py::arg("name"), "CommTask constructor")
970 .def_static("init", py::overload_cast<const std::string&, double, Host*, Host*>(&CommTask::init),
971 py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("source"),
972 py::arg("destination"), "CommTask constructor")
973 .def_property("source", &CommTask::get_source, &CommTask::set_source, "The source of the communication.")
974 .def_property("destination", &CommTask::get_destination, &CommTask::set_destination,
975 "The destination of the communication.")
976 .def_property("bytes", &CommTask::get_bytes, &CommTask::set_bytes, "The amount of bytes to send.")
978 "__repr__", [](const CommTaskPtr c) { return "CommTask(" + c->get_name() + ")"; },
979 "Textual representation of the CommTask");
982 py::class_<ExecTask, ExecTaskPtr, Task>(m, "ExecTask", "Execution Task. See the C++ documentation for details.")
983 .def_static("init", py::overload_cast<const std::string&>(&ExecTask::init),
984 py::call_guard<py::gil_scoped_release>(), py::arg("name"), "ExecTask constructor")
985 .def_static("init", py::overload_cast<const std::string&, double, Host*>(&ExecTask::init),
986 py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("flops"), py::arg("host"),
987 "CommTask constructor.")
988 .def_property("host", &ExecTask::get_host, &ExecTask::set_host, "The host of the execution.")
989 .def_property("flops", &ExecTask::get_flops, &ExecTask::set_flops, "The amount of flops to execute.")
991 "__repr__", [](const ExecTaskPtr e) { return "ExecTask(" + e->get_name() + ")"; },
992 "Textual representation of the ExecTask");
995 py::class_<IoTask, IoTaskPtr, Task>(m, "IoTask", "IO Task. See the C++ documentation for details.")
996 .def_static("init", py::overload_cast<const std::string&>(&IoTask::init),
997 py::call_guard<py::gil_scoped_release>(), py::arg("name"), "IoTask constructor")
998 .def_static("init", py::overload_cast<const std::string&, double, Disk*, Io::OpType>(&IoTask::init),
999 py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("disk"),
1000 py::arg("type"), "IoTask constructor.")
1001 .def_property("disk", &IoTask::get_disk, &IoTask::set_disk, "The disk of the IO.")
1002 .def_property("bytes", &IoTask::get_bytes, &IoTask::set_bytes, "The amount of bytes to process.")
1003 .def_property("type", &IoTask::get_bytes, &IoTask::set_bytes, "The type of IO.")
1005 "__repr__", [](const IoTaskPtr io) { return "IoTask(" + io->get_name() + ")"; },
1006 "Textual representation of the IoTask");