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/plugins/load.h"
14 #include <simgrid/Exception.hpp>
15 #include <simgrid/s4u/ActivitySet.hpp>
16 #include <simgrid/s4u/Actor.hpp>
17 #include <simgrid/s4u/Barrier.hpp>
18 #include <simgrid/s4u/Comm.hpp>
19 #include <simgrid/s4u/Disk.hpp>
20 #include <simgrid/s4u/Engine.hpp>
21 #include <simgrid/s4u/Exec.hpp>
22 #include <simgrid/s4u/Host.hpp>
23 #include <simgrid/s4u/Io.hpp>
24 #include <simgrid/s4u/Link.hpp>
25 #include <simgrid/s4u/Mailbox.hpp>
26 #include <simgrid/s4u/Mutex.hpp>
27 #include <simgrid/s4u/NetZone.hpp>
28 #include <simgrid/s4u/Semaphore.hpp>
29 #include <simgrid/s4u/Task.hpp>
30 #include <simgrid/version.h>
37 namespace py = pybind11;
38 using simgrid::s4u::Activity;
39 using simgrid::s4u::ActivityPtr;
40 using simgrid::s4u::ActivitySet;
41 using simgrid::s4u::ActivitySetPtr;
42 using simgrid::s4u::Actor;
43 using simgrid::s4u::ActorPtr;
44 using simgrid::s4u::Barrier;
45 using simgrid::s4u::BarrierPtr;
46 using simgrid::s4u::Comm;
47 using simgrid::s4u::CommPtr;
48 using simgrid::s4u::CommTask;
49 using simgrid::s4u::CommTaskPtr;
50 using simgrid::s4u::Disk;
51 using simgrid::s4u::Engine;
52 using simgrid::s4u::ExecTask;
53 using simgrid::s4u::ExecTaskPtr;
54 using simgrid::s4u::Host;
55 using simgrid::s4u::Io;
56 using simgrid::s4u::IoTask;
57 using simgrid::s4u::IoTaskPtr;
58 using simgrid::s4u::Link;
59 using simgrid::s4u::Mailbox;
60 using simgrid::s4u::Mutex;
61 using simgrid::s4u::MutexPtr;
62 using simgrid::s4u::Semaphore;
63 using simgrid::s4u::SemaphorePtr;
64 using simgrid::s4u::Task;
65 using simgrid::s4u::TaskPtr;
67 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
71 std::string get_simgrid_version()
76 sg_version_get(&major, &minor, &patch);
77 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
81 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
83 PYBIND11_MODULE(simgrid, m)
85 m.doc() = "SimGrid userspace API";
87 m.attr("simgrid_version") = get_simgrid_version();
89 // Swapped contexts are broken, starting from pybind11 v2.8.0. Use thread contexts by default.
90 simgrid::s4u::Engine::set_config("contexts/factory:thread");
92 // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
93 static py::object pyForcefulKillEx(py::register_exception<simgrid::ForcefulKillException>(m, "ActorKilled"));
95 py::register_exception<simgrid::NetworkFailureException>(m, "NetworkFailureException");
96 py::register_exception<simgrid::TimeoutException>(m, "TimeoutException");
97 py::register_exception<simgrid::HostFailureException>(m, "HostFailureException");
98 py::register_exception<simgrid::StorageFailureException>(m, "StorageFailureException");
99 py::register_exception<simgrid::VmFailureException>(m, "VmFailureException");
100 py::register_exception<simgrid::CancelException>(m, "CancelException");
101 py::register_exception<simgrid::AssertionError>(m, "AssertionError");
103 /* this_actor namespace */
104 m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.")
106 "debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.")
108 "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
110 "warning", [](const char* s) { XBT_WARN("%s", s); }, "Display a logging message of 'warning' priority.")
112 "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
113 .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
114 py::call_guard<py::gil_scoped_release>(),
115 "Block the current actor, computing the given amount of flops at the given priority.", py::arg("flops"),
116 py::arg("priority") = 1)
117 .def("exec_init", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_init),
118 py::call_guard<py::gil_scoped_release>())
119 .def("exec_async", py::overload_cast<double>(&simgrid::s4u::this_actor::exec_async),
120 py::call_guard<py::gil_scoped_release>())
121 .def("parallel_execute", &simgrid::s4u::this_actor::parallel_execute, py::call_guard<py::gil_scoped_release>(),
122 "Run a parallel task (requires the 'ptask_L07' model)")
124 py::overload_cast<const std::vector<simgrid::s4u::Host*>&, const std::vector<double>&,
125 const std::vector<double>&>(&simgrid::s4u::this_actor::exec_init),
126 py::call_guard<py::gil_scoped_release>(), "Initiate a parallel task (requires the 'ptask_L07' model)")
127 .def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located")
128 .def("set_host", &simgrid::s4u::this_actor::set_host, py::call_guard<py::gil_scoped_release>(),
129 "Moves the current actor to another host.", py::arg("dest"))
130 .def("sleep_for", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_for),
131 py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping for that amount of seconds.",
133 .def("sleep_until", static_cast<void (*)(double)>(&simgrid::s4u::this_actor::sleep_until),
134 py::call_guard<py::gil_scoped_release>(), "Block the actor sleeping until the specified timestamp.",
136 .def("suspend", &simgrid::s4u::this_actor::suspend, py::call_guard<py::gil_scoped_release>(),
137 "Suspend the current actor, that is blocked until resume()ed by another actor.")
138 .def("yield_", &simgrid::s4u::this_actor::yield, py::call_guard<py::gil_scoped_release>(), "Yield the actor")
139 .def("exit", &simgrid::s4u::this_actor::exit, py::call_guard<py::gil_scoped_release>(), "kill the current actor")
143 fun.inc_ref(); // keep alive after return
144 const py::gil_scoped_release gil_release;
145 simgrid::s4u::this_actor::on_exit([fun_p = fun.ptr()](bool failed) {
146 const py::gil_scoped_acquire py_context; // need a new context for callback
148 const auto fun = py::reinterpret_borrow<py::function>(fun_p);
150 } catch (const py::error_already_set& e) {
151 xbt_die("Error while executing the on_exit lambda: %s", e.what());
155 "Define a lambda to be called when the actor ends. It takes a bool parameter indicating whether the actor "
156 "was killed. If False, the actor finished peacefully.")
157 .def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
158 .def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
159 "Retrieves PPID of the current actor (i.e., the PID of its parent).");
162 py::class_<Engine>(m, "Engine", "Simulation Engine")
163 .def(py::init([](std::vector<std::string> args) {
164 auto argc = static_cast<int>(args.size());
165 std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
166 std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
167 // Currently this can be dangling, we should wrap this somehow.
168 return new simgrid::s4u::Engine(&argc, argv.data());
170 "The constructor should take the parameters from the command line, as is ")
171 .def_property_readonly_static(
172 "clock", [](py::object /* self */) { return Engine::get_clock(); },
173 "The simulation time, ie the amount of simulated seconds since the simulation start.")
174 .def_property_readonly_static(
175 "instance", [](py::object /* self */) { return Engine::get_instance(); }, "Retrieve the simulation engine")
176 .def("host_by_name", &Engine::host_by_name_or_null,
177 "Retrieve a host by its name, or None if it does not exist in the platform.")
178 .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
179 .def_property_readonly("all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
180 .def_property_readonly("all_netpoints", &Engine::get_all_netpoints)
181 .def_property_readonly("netzone_root", &Engine::get_netzone_root,
182 "Retrieve the root netzone, containing all others.")
183 .def("netpoint_by_name", &Engine::netpoint_by_name_or_null)
184 .def("netzone_by_name", &Engine::netzone_by_name_or_null)
185 .def("set_config", py::overload_cast<const std::string&>(&Engine::set_config),
186 "Change one of SimGrid's configurations")
187 .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
188 .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
189 .def("mailbox_by_name_or_create", &Engine::mailbox_by_name_or_create, py::call_guard<py::gil_scoped_release>(),
190 py::arg("name"), "Find a mailbox from its name or create one if it does not exist")
191 .def("run", &Engine::run, py::call_guard<py::gil_scoped_release>(), "Run the simulation until its end")
192 .def("run_until", py::overload_cast<double>(&Engine::run_until, py::const_),
193 py::call_guard<py::gil_scoped_release>(), "Run the simulation until the given date",
194 py::arg("max_date") = -1)
197 [](Engine* e, const std::string& name, py::object fun_or_class) {
198 fun_or_class.inc_ref(); // keep alive after return
199 const py::gil_scoped_release gil_release;
200 e->register_actor(name, [fun_or_class_p = fun_or_class.ptr()](std::vector<std::string> args) {
201 const py::gil_scoped_acquire py_context;
203 /* Convert the std::vector into a py::tuple */
204 py::tuple params(args.size() - 1);
205 for (size_t i = 1; i < args.size(); i++)
206 params[i - 1] = py::cast(args[i]);
208 const auto fun_or_class = py::reinterpret_borrow<py::object>(fun_or_class_p);
209 py::object res = fun_or_class(*params);
210 /* If I was passed a class, I just built an instance, so I need to call it now */
211 if (py::isinstance<py::function>(res))
213 } catch (const py::error_already_set& ex) {
214 if (ex.matches(pyForcefulKillEx)) {
215 XBT_VERB("Actor killed");
216 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
222 "Registers the main function of an actor")
223 .def("set_log_control", [](Engine*, const std::string& settings) { xbt_log_control_set(settings.c_str()); });
226 py::class_<simgrid::s4u::NetZone, std::unique_ptr<simgrid::s4u::NetZone, py::nodelete>> netzone(
227 m, "NetZone", "Networking Zones. See the C++ documentation for details.");
228 netzone.def_static("create_full_zone", &simgrid::s4u::create_full_zone, "Creates a zone of type FullZone")
229 .def_static("create_torus_zone", &simgrid::s4u::create_torus_zone, "Creates a cluster of type Torus")
230 .def_static("create_fatTree_zone", &simgrid::s4u::create_fatTree_zone, "Creates a cluster of type Fat-Tree")
231 .def_static("create_dragonfly_zone", &simgrid::s4u::create_dragonfly_zone, "Creates a cluster of type Dragonfly")
232 .def_static("create_star_zone", &simgrid::s4u::create_star_zone, "Creates a zone of type Star")
233 .def_static("create_floyd_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Floyd")
234 .def_static("create_dijkstra_zone", &simgrid::s4u::create_floyd_zone, "Creates a zone of type Dijkstra")
235 .def_static("create_vivaldi_zone", &simgrid::s4u::create_vivaldi_zone, "Creates a zone of type Vivaldi")
236 .def_static("create_empty_zone", &simgrid::s4u::create_empty_zone, "Creates a zone of type Empty")
237 .def_static("create_wifi_zone", &simgrid::s4u::create_wifi_zone, "Creates a zone of type Wi-Fi")
239 py::overload_cast<const simgrid::s4u::Host*, const simgrid::s4u::Host*,
240 const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
241 "Add a route between 2 hosts")
243 py::overload_cast<const simgrid::s4u::Host*, const simgrid::s4u::Host*,
244 const std::vector<const simgrid::s4u::Link*>&>(&simgrid::s4u::NetZone::add_route),
245 "Add a route between 2 hosts")
247 py::overload_cast<const simgrid::s4u::NetZone*, const simgrid::s4u::NetZone*,
248 const std::vector<simgrid::s4u::LinkInRoute>&, bool>(&simgrid::s4u::NetZone::add_route),
249 "Add a route between 2 netzones. The gateway of each zone gets used.")
251 py::overload_cast<const simgrid::s4u::NetZone*, const simgrid::s4u::NetZone*,
252 const std::vector<const simgrid::s4u::Link*>&>(&simgrid::s4u::NetZone::add_route),
253 "Add a route between 2 netzones. The gateway of each zone gets used.")
254 .def("create_host", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_host),
257 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_host),
260 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_host),
263 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_host),
265 .def("create_link", py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_link),
266 "Creates a network link")
268 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_link),
269 "Creates a network link")
271 py::overload_cast<const std::string&, const std::vector<double>&>(&simgrid::s4u::NetZone::create_link),
272 "Creates a network link")
274 py::overload_cast<const std::string&, const std::vector<std::string>&>(&simgrid::s4u::NetZone::create_link),
275 "Creates a network link")
276 .def("create_split_duplex_link",
277 py::overload_cast<const std::string&, double>(&simgrid::s4u::NetZone::create_split_duplex_link),
278 "Creates a split-duplex link")
279 .def("create_split_duplex_link",
280 py::overload_cast<const std::string&, const std::string&>(&simgrid::s4u::NetZone::create_split_duplex_link),
281 "Creates a split-duplex link")
282 .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
283 .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
284 .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
285 .def("set_gateway", py::overload_cast<const simgrid::s4u::Host*>(&simgrid::s4u::NetZone::set_gateway),
286 "Specify the gateway of this zone, to be used for inter-zone routes")
287 .def("set_gateway", py::overload_cast<simgrid::kernel::routing::NetPoint*>(&simgrid::s4u::NetZone::set_gateway),
288 "Specify the gateway of this zone, to be used for inter-zone routes")
289 .def_property_readonly("netpoint", &simgrid::s4u::NetZone::get_netpoint,
290 "Retrieve the netpoint associated to this zone")
291 .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
292 .def_property_readonly("name", &simgrid::s4u::NetZone::get_name,
293 "The name of this network zone (read-only property).")
295 "__repr__", [](const simgrid::s4u::NetZone net) { return "NetZone(" + net.get_name() + ")"; },
296 "Textual representation of the NetZone");
298 /* Class ClusterCallbacks */
299 py::class_<simgrid::s4u::ClusterCallbacks>(m, "ClusterCallbacks", "Callbacks used to create cluster zones")
300 .def(py::init<const std::function<simgrid::s4u::ClusterCallbacks::ClusterNetZoneCb>&,
301 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&,
302 const std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb>&>());
304 /* Class FatTreeParams */
305 py::class_<simgrid::s4u::FatTreeParams>(m, "FatTreeParams", "Parameters to create a Fat-Tree zone")
306 .def(py::init<unsigned int, const std::vector<unsigned int>&, const std::vector<unsigned int>&,
307 const std::vector<unsigned int>&>());
309 /* Class DragonflyParams */
310 py::class_<simgrid::s4u::DragonflyParams>(m, "DragonflyParams", "Parameters to create a Dragonfly zone")
311 .def(py::init<const std::pair<unsigned int, unsigned int>&, const std::pair<unsigned int, unsigned int>&,
312 const std::pair<unsigned int, unsigned int>&, unsigned int>());
315 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
316 m, "Host", "Simulated host. See the C++ documentation for details.");
317 host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die")
320 [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
321 auto* list = new std::vector<Link*>();
323 h->route_to(to, *list, &bw);
324 return make_tuple(list, bw);
326 "Retrieves the list of links and the bandwidth between two hosts.")
329 [](Host* h, const std::string& profile, double period) {
330 h->set_speed_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
332 py::call_guard<py::gil_scoped_release>(),
333 "Specify a profile modeling the external load according to an exhaustive list. "
334 "Each line of the profile describes timed events as ``date ratio``. "
335 "For example, the following content describes an host which computational speed is initially 1 (i.e, 100%) "
336 "and then halved after 42 seconds:\n\n"
337 ".. code-block:: python\n\n"
342 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
343 " while speed profiles of hosts contain ratios.\n\n"
344 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
345 "the list. Set it to -1 to not loop over.")
348 [](Host* h, const std::string& profile, double period) {
349 h->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
351 py::call_guard<py::gil_scoped_release>(),
352 "Specify a profile modeling the churn. "
353 "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
354 "whether the host is on. "
355 "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
356 ".. code-block:: python\n\n"
361 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
362 "the list. Set it to -1 to not loop over.")
363 .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
364 .def("pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
365 .def_property_readonly("netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this zone")
366 .def_property_readonly("disks", &Host::get_disks, "The list of disks on this host (read-only).")
367 .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
368 .def_property("core_count", &Host::get_core_count,
369 py::cpp_function(&Host::set_core_count, py::call_guard<py::gil_scoped_release>()),
370 "Manage the number of cores in the CPU")
371 .def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
372 "Set the coordinates of this host")
373 .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
374 "Describe how the CPU is shared", py::arg("policy"), py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
375 .def("create_disk", py::overload_cast<const std::string&, double, double>(&Host::create_disk),
376 py::call_guard<py::gil_scoped_release>(), "Create a disk")
378 py::overload_cast<const std::string&, const std::string&, const std::string&>(&Host::create_disk),
379 py::call_guard<py::gil_scoped_release>(), "Create a disk")
380 .def("seal", &Host::seal, py::call_guard<py::gil_scoped_release>(), "Seal this host")
381 .def("turn_off", &Host::turn_off, py::call_guard<py::gil_scoped_release>(), "Turn off this host")
382 .def("turn_on", &Host::turn_on, py::call_guard<py::gil_scoped_release>(), "Turn on this host")
383 .def_property("pstate", &Host::get_pstate,
384 py::cpp_function(&Host::set_pstate, py::call_guard<py::gil_scoped_release>()),
385 "The current pstate (read/write property).")
386 .def_static("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
387 "Retrieves the host on which the running actor is located.")
388 .def_property_readonly("name", &Host::get_name, "The name of this host (read-only property).")
389 .def_property_readonly("load", &Host::get_load,
390 "Returns the current computation load (in flops per second), NOT taking the external load "
391 "into account. This is the currently achieved speed (read-only property).")
392 .def_property_readonly(
393 "speed", &Host::get_speed,
394 "The peak computing speed in flops/s at the current pstate, NOT taking the external load into account. "
395 "This is the max potential speed (read-only property).")
396 .def_property_readonly("available_speed", &Host::get_available_speed,
397 "Get the available speed ratio, between 0 and 1.\n"
398 "This accounts for external load (see :py:func:`set_speed_profile() "
399 "<simgrid.Host.set_speed_profile>`) (read-only property).")
403 cb.inc_ref(); // keep alive after return
404 const py::gil_scoped_release gil_release;
405 Host::on_creation_cb([cb_p = cb.ptr()](Host& h) {
406 const py::gil_scoped_acquire py_context; // need a new context for callback
408 const auto fun = py::reinterpret_borrow<py::function>(cb_p);
410 } catch (const py::error_already_set& e) {
411 xbt_die("Error while executing the on_creation lambda : %s", e.what());
417 "__repr__", [](const Host* h) { return "Host(" + h->get_name() + ")"; },
418 "Textual representation of the Host.");
420 m.def("sg_host_load_plugin_init", [host]() {
421 sg_host_load_plugin_init();
423 static_cast<pybind11::class_<simgrid::s4u::Host, std::unique_ptr<simgrid::s4u::Host, pybind11::nodelete>>>(host)
425 "reset_load", [](const Host* h) { sg_host_load_reset(h); }, py::call_guard<py::gil_scoped_release>(),
426 "Reset counters of the host load plugin for this host.")
427 .def_property_readonly(
428 "current_load", [](const Host* h) { return sg_host_get_current_load(h); }, "Current load of the host.")
429 .def_property_readonly(
430 "avg_load", [](const Host* h) { return sg_host_get_avg_load(h); }, "Average load of the host.")
431 .def_property_readonly(
432 "idle_time", [](const Host* h) { return sg_host_get_idle_time(h); }, "Idle time of the host")
433 .def_property_readonly(
434 "total_idle_time", [](const Host* h) { return sg_host_get_total_idle_time(h); },
435 "Total idle time of the host.")
436 .def_property_readonly(
437 "computed_flops", [](const Host* h) { return sg_host_get_computed_flops(h); },
438 "Computed flops of the host.");
441 py::enum_<simgrid::s4u::Host::SharingPolicy>(host, "SharingPolicy")
442 .value("NONLINEAR", simgrid::s4u::Host::SharingPolicy::NONLINEAR)
443 .value("LINEAR", simgrid::s4u::Host::SharingPolicy::LINEAR);
446 py::class_<simgrid::s4u::Disk, std::unique_ptr<simgrid::s4u::Disk, py::nodelete>> disk(
447 m, "Disk", "Simulated disk. See the C++ documentation for details.");
448 disk.def("read", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::read, py::const_),
449 py::call_guard<py::gil_scoped_release>(), "Read data from disk", py::arg("size"), py::arg("priority") = 1)
450 .def("write", py::overload_cast<sg_size_t, double>(&simgrid::s4u::Disk::write, py::const_),
451 py::call_guard<py::gil_scoped_release>(), "Write data in disk", py::arg("size"), py::arg("priority") = 1)
452 .def("read_async", &simgrid::s4u::Disk::read_async, py::call_guard<py::gil_scoped_release>(),
453 "Non-blocking read data from disk")
454 .def("write_async", &simgrid::s4u::Disk::write_async, py::call_guard<py::gil_scoped_release>(),
455 "Non-blocking write data in disk")
456 .def("set_sharing_policy", &simgrid::s4u::Disk::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
457 "Set sharing policy for this disk", py::arg("op"), py::arg("policy"),
458 py::arg("cb") = simgrid::s4u::NonLinearResourceCb())
459 .def("seal", &simgrid::s4u::Disk::seal, py::call_guard<py::gil_scoped_release>(), "Seal this disk")
460 .def_property_readonly("name", &simgrid::s4u::Disk::get_name, "The name of this disk (read-only property).")
462 "__repr__", [](const Disk* d) { return "Disk(" + d->get_name() + ")"; },
463 "Textual representation of the Disk");
464 py::enum_<simgrid::s4u::Disk::SharingPolicy>(disk, "SharingPolicy")
465 .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR)
466 .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR);
467 py::enum_<simgrid::s4u::Disk::Operation>(disk, "Operation")
468 .value("READ", simgrid::s4u::Disk::Operation::READ)
469 .value("WRITE", simgrid::s4u::Disk::Operation::WRITE)
470 .value("READWRITE", simgrid::s4u::Disk::Operation::READWRITE);
473 py::class_<simgrid::kernel::routing::NetPoint, std::unique_ptr<simgrid::kernel::routing::NetPoint, py::nodelete>>
474 netpoint(m, "NetPoint", "NetPoint object");
477 py::class_<Link, std::unique_ptr<Link, py::nodelete>> link(m, "Link",
478 "Network link. See the C++ documentation for details.");
479 link.def("set_latency", py::overload_cast<const std::string&>(&Link::set_latency),
480 py::call_guard<py::gil_scoped_release>(),
481 "Set the latency as a string. Accepts values with units, such as ‘1s’ or ‘7ms’.\nFull list of accepted "
482 "units: w (week), d (day), h, s, ms, us, ns, ps.")
483 .def("set_latency", py::overload_cast<double>(&Link::set_latency), py::call_guard<py::gil_scoped_release>(),
484 "Set the latency as a float (in seconds).")
485 .def("set_bandwidth", &Link::set_bandwidth, py::call_guard<py::gil_scoped_release>(),
486 "Set the bandwidth (in byte per second).")
488 "set_bandwidth_profile",
489 [](Link* l, const std::string& profile, double period) {
490 l->set_bandwidth_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
492 py::call_guard<py::gil_scoped_release>(),
493 "Specify a profile modeling the external load according to an exhaustive list. "
494 "Each line of the profile describes timed events as ``date bandwidth`` (in bytes per second). "
495 "For example, the following content describes a link which bandwidth changes to 40 Mb/s at t=4, and to 6 "
497 ".. code-block:: python\n\n"
502 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
503 " while speed profiles of hosts contain ratios.\n\n"
504 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
505 "the list. Set it to -1 to not loop over.")
507 "set_latency_profile",
508 [](Link* l, const std::string& profile, double period) {
509 l->set_latency_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
511 py::call_guard<py::gil_scoped_release>(),
512 "Specify a profile modeling the external load according to an exhaustive list. "
513 "Each line of the profile describes timed events as ``date latency`` (in seconds). "
514 "For example, the following content describes a link which latency changes to 1ms (0.001s) at t=1, and to 2s "
516 ".. code-block:: python\n\n"
521 ".. warning:: Don't get fooled: bandwidth and latency profiles of links contain absolute values,"
522 " while speed profiles of hosts contain ratios.\n\n"
523 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
524 "the list. Set it to -1 to not loop over.")
527 [](Link* l, const std::string& profile, double period) {
528 l->set_state_profile(simgrid::kernel::profile::ProfileBuilder::from_string("", profile, period));
530 "Specify a profile modeling the churn. "
531 "Each line of the profile describes timed events as ``date boolean``, where the boolean (0 or 1) tells "
532 "whether the link is on. "
533 "For example, the following content describes a link which turns off at t=1 and back on at t=2:\n\n"
534 ".. code-block:: python\n\n"
539 "The second function parameter is the periodicity: the time to wait after the last event to start again over "
540 "the list. Set it to -1 to not loop over.")
542 .def("turn_on", &Link::turn_on, py::call_guard<py::gil_scoped_release>(), "Turns the link on.")
543 .def("turn_off", &Link::turn_off, py::call_guard<py::gil_scoped_release>(), "Turns the link off.")
544 .def("is_on", &Link::is_on, "Check whether the link is on.")
546 .def("set_sharing_policy", &Link::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
547 "Set sharing policy for this link")
548 .def("set_concurrency_limit", &Link::set_concurrency_limit, py::call_guard<py::gil_scoped_release>(),
549 "Set concurrency limit for this link")
550 .def("set_host_wifi_rate", &Link::set_host_wifi_rate, py::call_guard<py::gil_scoped_release>(),
551 "Set level of communication speed of given host on this Wi-Fi link")
552 .def_static("by_name", &Link::by_name, "Retrieves a Link from its name, or dies")
553 .def("seal", &Link::seal, py::call_guard<py::gil_scoped_release>(), "Seal this link")
554 .def_property_readonly("name", &Link::get_name, "The name of this link")
555 .def_property_readonly("bandwidth", &Link::get_bandwidth,
556 "The bandwidth (in bytes per second) (read-only property).")
557 .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property).")
559 "__repr__", [](const Link* l) { return "Link(" + l->get_name() + ")"; },
560 "Textual representation of the Link");
561 py::enum_<Link::SharingPolicy>(link, "SharingPolicy")
562 .value("NONLINEAR", Link::SharingPolicy::NONLINEAR,
563 "This policy takes a callback that specifies the maximal capacity as a function of the number of usage. "
564 "See the examples with 'degradation' in their name.")
565 .value("WIFI", Link::SharingPolicy::WIFI, "Pseudo-sharing policy requesting wifi-specific sharing.")
566 .value("SPLITDUPLEX", Link::SharingPolicy::SPLITDUPLEX,
567 "Each link is split in 2, UP and DOWN, one per direction. These links are SHARED.")
568 .value("SHARED", Link::SharingPolicy::SHARED,
569 "The bandwidth is shared between all comms using that link, regardless of their direction.")
570 .value("FATPIPE", Link::SharingPolicy::FATPIPE,
571 "Each comm can use the link fully, with no sharing (only a maximum). This is intended to represent the "
572 "backbone links that cannot be saturated by concurrent links, but have a maximal bandwidth.");
574 /* Class LinkInRoute */
575 py::class_<simgrid::s4u::LinkInRoute> linkinroute(m, "LinkInRoute", "Abstraction to add link in routes");
576 linkinroute.def(py::init<const Link*>());
577 linkinroute.def(py::init<const Link*, simgrid::s4u::LinkInRoute::Direction>());
578 py::enum_<simgrid::s4u::LinkInRoute::Direction>(linkinroute, "Direction")
579 .value("UP", simgrid::s4u::LinkInRoute::Direction::UP)
580 .value("DOWN", simgrid::s4u::LinkInRoute::Direction::DOWN)
581 .value("NONE", simgrid::s4u::LinkInRoute::Direction::NONE);
583 /* Class Split-Duplex Link */
584 py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
585 m, "SplitDuplexLink", "Network split-duplex link")
586 .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
587 .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
590 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
591 m, "Mailbox", "Mailbox. See the C++ documentation for details.")
593 "__repr__", [](const Mailbox* self) { return "Mailbox(" + self->get_name() + ")"; },
594 "Textual representation of the Mailbox")
595 .def_static("by_name", &Mailbox::by_name, py::call_guard<py::gil_scoped_release>(), py::arg("name"),
596 "Retrieve a Mailbox from its name")
597 .def_property_readonly("name", &Mailbox::get_name, "The name of that mailbox (read-only property).")
598 .def_property_readonly("ready", &Mailbox::ready,
599 "Check if there is a communication ready to be consumed from a mailbox.")
602 [](Mailbox* self, py::object data, uint64_t size, double timeout) {
603 auto* data_ptr = data.inc_ref().ptr();
604 const py::gil_scoped_release gil_release;
605 self->put(data_ptr, size, timeout);
607 "Blocking data transmission with a timeout")
610 [](Mailbox* self, py::object data, uint64_t size) {
611 auto* data_ptr = data.inc_ref().ptr();
612 const py::gil_scoped_release gil_release;
613 self->put(data_ptr, size);
615 "Blocking data transmission")
618 [](Mailbox* self, py::object data, uint64_t size) {
619 auto* data_ptr = data.inc_ref().ptr();
620 const py::gil_scoped_release gil_release;
621 return self->put_async(data_ptr, size);
623 "Non-blocking data transmission")
626 [](Mailbox* self, py::object data, uint64_t size) {
627 auto* data_ptr = data.inc_ref().ptr();
628 const py::gil_scoped_release gil_release;
629 return self->put_init(data_ptr, size);
631 "Creates (but don’t start) a data transmission to that mailbox.")
633 "get", [](Mailbox* self) { return py::reinterpret_steal<py::object>(self->get<PyObject>()); },
634 py::call_guard<py::gil_scoped_release>(), "Blocking data reception")
636 "get_async", [](Mailbox* self) -> CommPtr { return self->get_async(); },
637 py::call_guard<py::gil_scoped_release>(),
638 "Non-blocking data reception. Use data.get() to get the python object after the communication has finished")
639 .def("set_receiver", &Mailbox::set_receiver, py::call_guard<py::gil_scoped_release>(),
640 "Sets the actor as permanent receiver");
643 py::class_<Activity, ActivityPtr>(m, "Activity", "Activity. See the C++ documentation for details.");
646 py::class_<Comm, CommPtr, Activity>(m, "Comm", "Communication. See the C++ documentation for details.")
647 .def_property_readonly("dst_data_size", &Comm::get_dst_data_size, py::call_guard<py::gil_scoped_release>(),
648 "Retrieve the size of the received data.")
649 .def_property_readonly("mailbox", &Comm::get_mailbox, py::call_guard<py::gil_scoped_release>(),
650 "Retrieve the mailbox on which this comm acts.")
651 .def_property_readonly("sender", &Comm::get_sender, py::call_guard<py::gil_scoped_release>())
652 .def_property_readonly("state_str", &Comm::get_state_str, py::call_guard<py::gil_scoped_release>(),
653 "Retrieve the Comm state as string")
654 .def_property_readonly("remaining", &Comm::get_remaining, py::call_guard<py::gil_scoped_release>(),
655 "Remaining amount of work that this Comm entails")
656 .def_property_readonly("start_time", &Comm::get_start_time, py::call_guard<py::gil_scoped_release>(),
657 "Time at which this Comm started")
658 .def_property_readonly("finish_time", &Comm::get_finish_time, py::call_guard<py::gil_scoped_release>(),
659 "Time at which this Comm finished")
660 .def_property_readonly("is_suspended", &Comm::is_suspended, py::call_guard<py::gil_scoped_release>(),
661 "Whether this Comm is suspended")
662 .def("set_payload_size", &Comm::set_payload_size, py::call_guard<py::gil_scoped_release>(), py::arg("bytes"),
663 "Specify the amount of bytes which exchange should be simulated.")
664 .def("set_rate", &Comm::set_rate, py::call_guard<py::gil_scoped_release>(), py::arg("rate"),
665 "Sets the maximal communication rate (in byte/sec). Must be done before start")
666 .def("cancel", &Comm::cancel, py::call_guard<py::gil_scoped_release>(),
667 py::return_value_policy::reference_internal, "Cancel the activity.")
668 .def("start", &Comm::start, py::call_guard<py::gil_scoped_release>(), py::return_value_policy::reference_internal,
669 "Starts a previously created activity. This function is optional: you can call wait() even if you didn't "
671 .def("suspend", &Comm::suspend, py::call_guard<py::gil_scoped_release>(),
672 py::return_value_policy::reference_internal, "Suspend the activity.")
673 .def("resume", &Comm::resume, py::call_guard<py::gil_scoped_release>(),
674 py::return_value_policy::reference_internal, "Resume the activity.")
675 .def("test", &Comm::test, py::call_guard<py::gil_scoped_release>(),
676 "Test whether the communication is terminated.")
677 .def("wait", &Comm::wait, py::call_guard<py::gil_scoped_release>(),
678 "Block until the completion of that communication.")
679 .def("wait_for", &Comm::wait_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
680 "Block until the completion of that communication, or raises TimeoutException after the specified timeout.")
681 .def("wait_until", &Comm::wait_until, py::call_guard<py::gil_scoped_release>(), py::arg("time_limit"),
682 "Block until the completion of that communication, or raises TimeoutException after the specified time.")
685 [](const Comm* self) { return py::reinterpret_steal<py::object>((PyObject*)self->get_payload()); },
686 py::call_guard<py::gil_scoped_release>(),
687 "Retrieve the message's payload of a get_async. You cannot call this until after the comm termination.")
688 .def("detach", py::overload_cast<>(&Comm::detach), py::return_value_policy::reference_internal,
689 py::call_guard<py::gil_scoped_release>(),
690 "Start the comm, and ignore its result. It can be completely forgotten after that.")
691 .def_static("sendto", &Comm::sendto, py::call_guard<py::gil_scoped_release>(), py::arg("from"), py::arg("to"),
692 py::arg("simulated_size_in_bytes"), "Do a blocking communication between two arbitrary hosts.")
693 .def_static("sendto_init", py::overload_cast<Host*, Host*>(&Comm::sendto_init),
694 py::call_guard<py::gil_scoped_release>(), py::arg("from"), py::arg("to"),
695 "Creates a communication between the two given hosts, bypassing the mailbox mechanism.")
696 .def_static("sendto_async", &Comm::sendto_async, py::call_guard<py::gil_scoped_release>(), py::arg("from"),
697 py::arg("to"), py::arg("simulated_size_in_bytes"),
698 "Do a blocking communication between two arbitrary hosts.\n\nThis initializes a communication that "
699 "completely bypass the mailbox and actors mechanism. There is really no limit on the hosts involved. "
700 "In particular, the actor does not have to be on one of the involved hosts.");
703 py::class_<simgrid::s4u::Io, simgrid::s4u::IoPtr, Activity>(m, "Io",
704 "I/O activities. See the C++ documentation for details.")
705 .def("test", &simgrid::s4u::Io::test, py::call_guard<py::gil_scoped_release>(),
706 "Test whether the I/O is terminated.")
707 .def("wait", &simgrid::s4u::Io::wait, py::call_guard<py::gil_scoped_release>(),
708 "Block until the completion of that I/O operation");
711 py::class_<simgrid::s4u::Exec, simgrid::s4u::ExecPtr, Activity>(m, "Exec",
712 "Execution. See the C++ documentation for details.")
713 .def_property_readonly("remaining", &simgrid::s4u::Exec::get_remaining, py::call_guard<py::gil_scoped_release>(),
714 "Amount of flops that remain to be computed until completion (read-only property).")
715 .def_property_readonly("remaining_ratio", &simgrid::s4u::Exec::get_remaining_ratio,
716 py::call_guard<py::gil_scoped_release>(),
717 "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done "
718 "yet) (read-only property).")
719 .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host,
720 "Host on which this execution runs. Only the first host is returned for parallel executions. "
721 "Changing this value migrates the execution.")
722 .def_property_readonly("is_suspended", &simgrid::s4u::Exec::is_suspended,
723 py::call_guard<py::gil_scoped_release>(), "Whether this Exec is suspended")
724 .def("test", &simgrid::s4u::Exec::test, py::call_guard<py::gil_scoped_release>(),
725 "Test whether the execution is terminated.")
726 .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard<py::gil_scoped_release>(), "Cancel that execution.")
727 .def("start", &simgrid::s4u::Exec::start, py::call_guard<py::gil_scoped_release>(), "Start that execution.")
728 .def("suspend", &simgrid::s4u::Exec::suspend, py::call_guard<py::gil_scoped_release>(), "Suspend that execution.")
729 .def("resume", &simgrid::s4u::Exec::resume, py::call_guard<py::gil_scoped_release>(), "Resume that execution.")
730 .def("wait", &simgrid::s4u::Exec::wait, py::call_guard<py::gil_scoped_release>(),
731 "Block until the completion of that execution.")
732 .def("wait_for", &simgrid::s4u::Exec::wait_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
733 "Block until the completion of that activity, or raises TimeoutException after the specified timeout.");
735 /* Class Semaphore */
736 py::class_<Semaphore, SemaphorePtr>(m, "Semaphore",
737 "A classical semaphore, but blocking in the simulation world. See the C++ "
738 "documentation for details.")
739 .def(py::init<>(&Semaphore::create), py::call_guard<py::gil_scoped_release>(), py::arg("capacity"),
740 "Semaphore constructor.")
741 .def("acquire", &Semaphore::acquire, py::call_guard<py::gil_scoped_release>(),
742 "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired.")
743 .def("acquire_timeout", &Semaphore::acquire_timeout, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
744 "Acquire on the semaphore object with no timeout. Blocks until the semaphore is acquired or return "
745 "true if it has not been acquired after the specified timeout.")
746 .def("release", &Semaphore::release, py::call_guard<py::gil_scoped_release>(), "Release the semaphore.")
747 .def_property_readonly("capacity", &Semaphore::get_capacity, py::call_guard<py::gil_scoped_release>(),
748 "Get the semaphore capacity.")
749 .def_property_readonly("would_block", &Semaphore::would_block, py::call_guard<py::gil_scoped_release>(),
750 "Check whether trying to acquire the semaphore would block (in other word, checks whether "
751 "this semaphore has capacity).")
752 // Allow semaphores to be automatically acquired/released with a context manager: `with semaphore: ...`
753 .def("__enter__", &Semaphore::acquire, py::call_guard<py::gil_scoped_release>())
755 [](Semaphore* self, const py::object&, const py::object&, const py::object&) { self->release(); });
758 py::class_<Mutex, MutexPtr>(m, "Mutex",
759 "A classical mutex, but blocking in the simulation world."
760 "See the C++ documentation for details.")
761 .def(py::init<>(&Mutex::create), py::call_guard<py::gil_scoped_release>(),
762 "Mutex constructor (pass True as a parameter to get a recursive Mutex).", py::arg("recursive") = false)
763 .def("lock", &Mutex::lock, py::call_guard<py::gil_scoped_release>(), "Block until the mutex is acquired.")
764 .def("try_lock", &Mutex::try_lock, py::call_guard<py::gil_scoped_release>(),
765 "Try to acquire the mutex. Return true if the mutex was acquired, false otherwise.")
766 .def("unlock", &Mutex::unlock, py::call_guard<py::gil_scoped_release>(), "Release the mutex.")
767 // Allow mutexes to be automatically acquired/released with a context manager: `with mutex: ...`
768 .def("__enter__", &Mutex::lock, py::call_guard<py::gil_scoped_release>())
770 "__exit__", [](Mutex* self, const py::object&, const py::object&, const py::object&) { self->unlock(); },
771 py::call_guard<py::gil_scoped_release>());
774 py::class_<Barrier, BarrierPtr>(m, "Barrier", "A classical barrier, but blocking in the simulation world.")
775 .def(py::init<>(&Barrier::create), py::call_guard<py::gil_scoped_release>(), py::arg("expected_actors"),
776 "Barrier constructor.")
777 .def("wait", &Barrier::wait, py::call_guard<py::gil_scoped_release>(),
778 "Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches "
782 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
783 "An actor is an independent stream of execution in your distributed "
784 "application. See the C++ documentation for details.")
787 [](const std::string& name, Host* h, py::object fun, py::args args) {
788 fun.inc_ref(); // keep alive after return
789 args.inc_ref(); // keep alive after return
790 const py::gil_scoped_release gil_release;
791 return simgrid::s4u::Actor::create(name, h, [fun_p = fun.ptr(), args_p = args.ptr()]() {
792 const py::gil_scoped_acquire py_context;
794 const auto fun = py::reinterpret_borrow<py::object>(fun_p);
795 const auto args = py::reinterpret_borrow<py::args>(args_p);
797 } catch (const py::error_already_set& ex) {
798 if (ex.matches(pyForcefulKillEx)) {
799 XBT_VERB("Actor killed");
800 simgrid::ForcefulKillException::do_throw(); // Forward that ForcefulKill exception
806 "Create an actor from a function or an object. See the :ref:`example <s4u_ex_actors_create>`.")
808 "host", &Actor::get_host, py::cpp_function(&Actor::set_host, py::call_guard<py::gil_scoped_release>()),
809 "The host on which this actor is located. Changing this value migrates the actor.\n\n"
810 "If the actor is currently blocked on an execution activity, the activity is also migrated to the new host. "
811 "If it’s blocked on another kind of activity, an error is raised as the mandated code is not written yet. "
812 "Please report that bug if you need it.\n\n"
813 "Asynchronous activities started by the actor are not migrated automatically, so you have to take care of "
814 "this yourself (only you knows which ones should be migrated). ")
815 .def_property_readonly("name", &Actor::get_cname, "The name of this actor (read-only property).")
816 .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).")
817 .def_property_readonly("ppid", &Actor::get_ppid,
818 "The PID (unique identifier) of the actor that created this one (read-only property).")
819 .def_static("by_pid", &Actor::by_pid, py::arg("pid"), "Retrieve an actor by its PID")
820 .def("set_auto_restart", &Actor::set_auto_restart, py::call_guard<py::gil_scoped_release>(),
821 "Specify whether the actor shall restart when its host reboots.")
822 .def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
823 "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
825 .def("is_daemon", &Actor::is_daemon,
826 "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
828 .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
829 "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout") = -1)
830 .def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
831 .def("self", &Actor::self, "Retrieves the current actor.")
832 .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
833 .def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
834 "Suspend that actor, that is blocked until resume()ed by another actor.")
835 .def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
836 "Resume that actor, that was previously suspend()ed.")
837 .def_static("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(),
838 "Kill all actors but the caller.")
840 "__repr__", [](const ActorPtr a) { return "Actor(" + a->get_name() + ")"; },
841 "Textual representation of the Actor");
843 /* Enum Class IoOpType */
844 py::enum_<simgrid::s4u::Io::OpType>(m, "IoOpType")
845 .value("READ", simgrid::s4u::Io::OpType::READ)
846 .value("WRITE", simgrid::s4u::Io::OpType::WRITE);
849 py::class_<Task, TaskPtr>(m, "Task", "Task. See the C++ documentation for details.")
853 cb.inc_ref(); // keep alive after return
854 const py::gil_scoped_release gil_release;
855 Task::on_start_cb([cb_p = cb.ptr()](Task* op) {
856 const py::gil_scoped_acquire py_context; // need a new context for callback
857 py::reinterpret_borrow<py::function>(cb_p)(op);
860 "Add a callback called when each task starts.")
864 cb.inc_ref(); // keep alive after return
865 const py::gil_scoped_release gil_release;
866 Task::on_completion_cb([cb_p = cb.ptr()](Task* op) {
867 const py::gil_scoped_acquire py_context; // need a new context for callback
868 py::reinterpret_borrow<py::function>(cb_p)(op);
871 "Add a callback called when each task ends.")
872 .def_property_readonly("name", &Task::get_name, "The name of this task (read-only).")
873 .def_property_readonly("successors", &Task::get_successors, "The successors of this task (read-only).")
874 .def_property("amount", &Task::get_amount, &Task::set_amount, "The amount of work to do for this task.")
876 "get_count", [](const TaskPtr t) { return t->get_count("instance_0"); },
877 "The execution count of this task instance_0.")
879 "get_count", [](const TaskPtr t, const std::string& instance) { return t->get_count(instance); },
880 "The execution count of this task instance.")
881 .def("enqueue_firings", py::overload_cast<int>(&Task::enqueue_firings), py::call_guard<py::gil_scoped_release>(),
882 py::arg("n"), "Enqueue firings for this task.")
883 .def("add_successor", py::overload_cast<TaskPtr>(&Task::add_successor), py::call_guard<py::gil_scoped_release>(),
884 py::arg("op"), "Add a successor to this task.")
885 .def("remove_successor", py::overload_cast<TaskPtr>(&Task::remove_successor),
886 py::call_guard<py::gil_scoped_release>(), py::arg("op"), "Remove a successor of this task.")
887 .def("remove_all_successors", &Task::remove_all_successors, py::call_guard<py::gil_scoped_release>(),
888 "Remove all successors of this task.")
889 .def("on_this_start_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_start_cb),
890 py::arg("func"), "Add a callback called when this task starts.")
891 .def("on_this_completion_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_completion_cb),
892 py::arg("func"), "Add a callback called when this task ends.")
894 "__repr__", [](const TaskPtr op) { return "Task(" + op->get_name() + ")"; },
895 "Textual representation of the Task");
898 py::class_<CommTask, CommTaskPtr, Task>(m, "CommTask", "Communication Task. See the C++ documentation for details.")
899 .def_static("init", py::overload_cast<const std::string&>(&CommTask::init),
900 py::call_guard<py::gil_scoped_release>(), py::arg("name"), "CommTask constructor")
901 .def_static("init", py::overload_cast<const std::string&, double, Host*, Host*>(&CommTask::init),
902 py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("source"),
903 py::arg("destination"), "CommTask constructor")
904 .def_property("source", &CommTask::get_source, &CommTask::set_source, "The source of the communication.")
905 .def_property("destination", &CommTask::get_destination, &CommTask::set_destination,
906 "The destination of the communication.")
907 .def_property("bytes", &CommTask::get_bytes, &CommTask::set_bytes, "The amount of bytes to send.")
909 "__repr__", [](const CommTaskPtr c) { return "CommTask(" + c->get_name() + ")"; },
910 "Textual representation of the CommTask");
913 py::class_<ExecTask, ExecTaskPtr, Task>(m, "ExecTask", "Execution Task. See the C++ documentation for details.")
914 .def_static("init", py::overload_cast<const std::string&>(&ExecTask::init),
915 py::call_guard<py::gil_scoped_release>(), py::arg("name"), "ExecTask constructor")
916 .def_static("init", py::overload_cast<const std::string&, double, Host*>(&ExecTask::init),
917 py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("flops"), py::arg("host"),
918 "CommTask constructor.")
919 .def_property("host", &ExecTask::get_host, &ExecTask::set_host, "The host of the execution.")
920 .def_property("flops", &ExecTask::get_flops, &ExecTask::set_flops, "The amount of flops to execute.")
922 "__repr__", [](const ExecTaskPtr e) { return "ExecTask(" + e->get_name() + ")"; },
923 "Textual representation of the ExecTask");
926 py::class_<IoTask, IoTaskPtr, Task>(m, "IoTask", "IO Task. See the C++ documentation for details.")
927 .def_static("init", py::overload_cast<const std::string&>(&IoTask::init),
928 py::call_guard<py::gil_scoped_release>(), py::arg("name"), "IoTask constructor")
929 .def_static("init", py::overload_cast<const std::string&, double, Disk*, Io::OpType>(&IoTask::init),
930 py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("disk"),
931 py::arg("type"), "IoTask constructor.")
932 .def_property("disk", &IoTask::get_disk, &IoTask::set_disk, "The disk of the IO.")
933 .def_property("bytes", &IoTask::get_bytes, &IoTask::set_bytes, "The amount of bytes to process.")
934 .def_property("type", &IoTask::get_bytes, &IoTask::set_bytes, "The type of IO.")
936 "__repr__", [](const IoTaskPtr io) { return "IoTask(" + io->get_name() + ")"; },
937 "Textual representation of the IoTask");
939 /* Class ActivitySet */
940 py::class_<ActivitySet, ActivitySetPtr>(m, "ActivitySet", "ActivitySet. See the C++ documentation for details.")
941 .def(py::init([](std::vector<simgrid::s4u::ActivityPtr> activities) {
942 auto* ret = new ActivitySet();
943 for (auto a : activities)
945 return ActivitySetPtr(ret);
947 "The constructor should take the parameters from the command line, as is ")
948 .def(py::init([]() { return ActivitySetPtr(new ActivitySet()); }),
949 "The constructor should take the parameters from the command line, as is ")
951 .def("push", &ActivitySet::push, py::call_guard<py::gil_scoped_release>(), py::arg("activity"),
952 "Add an activity to the set")
953 .def("erase", &ActivitySet::erase, py::call_guard<py::gil_scoped_release>(), py::arg("activity"),
954 "Remove that activity from the set")
955 .def_property_readonly("size", &ActivitySet::size, "Count of activities in the set")
956 .def("empty", &ActivitySet::empty, "Returns whether the set is empty")
957 .def("has_failed_activities", &ActivitySet::has_failed_activities,
958 "Returns whether there is any failed activities")
959 .def("get_failed_activity", &ActivitySet::get_failed_activity, "Returns a failed activity from the set, or None")
961 .def("wait_all_for", &ActivitySet::wait_all_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
962 "Wait for the completion of all activities in the set, but not longer than the provided timeout")
963 .def("wait_all", &ActivitySet::wait_all, py::call_guard<py::gil_scoped_release>(),
964 "Wait for the completion of all activities in the set, endlessly")
965 .def("test_any", &ActivitySet::test_any, py::call_guard<py::gil_scoped_release>(),
966 "Returns the first terminated activity if any, or None if no activity is terminated")
967 .def("wait_any_for", &ActivitySet::wait_any_for, py::call_guard<py::gil_scoped_release>(), py::arg("timeout"),
968 "Wait for the completion of one activity in the set, but not longer than the provided timeout")
969 .def("wait_any", &ActivitySet::wait_any, py::call_guard<py::gil_scoped_release>(),
970 "Wait for the completion of one activity in the set, endlessly")
973 "__repr__", [](const ActivitySetPtr as) { return "ActivitySet([...])"; },
974 "Textual representation of the ActivitySet");