1 /* Copyright (c) 2018. 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. */
10 #include <pybind11/pybind11.h>
11 #include <pybind11/stl.h>
13 #include <simgrid/s4u/Actor.hpp>
14 #include <simgrid/s4u/Engine.hpp>
15 #include <simgrid/s4u/Host.hpp>
16 #include <simgrid/s4u/Mailbox.hpp>
18 namespace py = pybind11;
19 using simgrid::s4u::Actor;
20 using simgrid::s4u::ActorPtr;
21 using simgrid::s4u::Engine;
22 using simgrid::s4u::Host;
23 using simgrid::s4u::Mailbox;
25 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
27 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>);
31 static std::string get_simgrid_version()
33 int major, minor, patch;
34 sg_version_get(&major, &minor, &patch);
35 return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
38 static std::string simgrid_version = get_simgrid_version();
42 PYBIND11_MODULE(simgrid, m)
45 m.doc() = "SimGrid userspace API";
47 m.attr("simgrid_version") = simgrid_version;
49 /* this_actor namespace */
50 void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload
51 void (*sleep_until_fun)(double) = &simgrid::s4u::this_actor::sleep_until;
53 py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.");
54 m2.def("info", [](char* s) { XBT_INFO("%s", s); }, "Display a logging message of default priority.");
55 m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
56 "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
57 "simgrid::s4u::this_actor::execute(double, double)`",
58 py::arg("flops"), py::arg("priority") = 1);
59 m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrives host on which the current actor is located");
60 m2.def("migrate", &simgrid::s4u::this_actor::migrate, "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::migrate()`",
62 m2.def("sleep_for", sleep_for_fun,
63 "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`", py::arg("duration"));
64 m2.def("sleep_until", sleep_until_fun,
65 "Block the actor sleeping until the specified timestamp, see :cpp:func:`void simgrid::s4u::this_actor::sleep_until`", py::arg("duration"));
66 m2.def("suspend", &simgrid::s4u::this_actor::suspend, "Suspend the current actor, that is blocked until resume()ed by another actor. see :cpp:func:`void simgrid::s4u::this_actor::suspend`");
67 m2.def("yield_", &simgrid::s4u::this_actor::yield,
68 "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
71 py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
72 .def(py::init([](std::vector<std::string> args) -> simgrid::s4u::Engine* {
73 static char noarg[] = {'\0'};
74 int argc = args.size();
75 std::unique_ptr<char* []> argv(new char*[argc + 1]);
76 for (int i = 0; i != argc; ++i)
77 argv[i] = args[i].empty() ? noarg : &args[i].front();
79 // Currently this can be dangling, we should wrap this somehow.
80 return new simgrid::s4u::Engine(&argc, argv.get());
82 .def("load_platform", &Engine::load_platform,
83 "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
84 .def("load_deployment", &Engine::load_deployment,
85 "Load a deployment file and launch the actors that it contains, see :cpp:func:`simgrid::s4u::Engine::load_deployment()`")
86 .def("run", &Engine::run, "Run the simulation")
87 .def("register_actor", [](Engine*, std::string name, py::object obj) {
88 simgrid::simix::register_function(name,
89 [obj](std::vector<std::string> args) -> simgrid::simix::ActorCode {
90 return [obj, args]() {
91 /* Convert the std::vector into a py::tuple */
92 py::tuple params(args.size()-1);
93 for (size_t i=1; i<args.size(); i++)
94 params[i-1] = py::cast(args[i]);
96 PyObject *result = PyObject_CallObject(obj.ptr(), params.ptr());
98 throw pybind11::error_already_set();
100 /* If I was passed a class, I just built an instance, so I need to call it now */
101 if (PyCallable_Check(result)) {
102 py::object obj2 = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(result)));
107 }, "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`")
111 py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
112 .def("by_name", &Host::by_name, "Retrieve a host from its name, or die")
113 .def_property_readonly("name", [](Host* self) -> const std::string {
114 return static_cast<std::string>(self->get_name());
115 }, "Retrieve the name of this host")
116 .def_property_readonly("speed", &Host::get_speed,
117 "Get the peak computing speed in flops/s at the current pstate, taking the external load into account, see :cpp:func:`simgrid::s4u::Host::get_speed()`");
120 py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
121 .def("by_name", &Mailbox::by_name, "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
122 .def_property_readonly("name", &Mailbox::get_name, "Retrieves the name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
123 .def("put", [](Mailbox self, py::object data, int size) {
125 self.put(data.ptr(), size);
126 }, "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
127 .def("get", [](Mailbox self) -> py::object {
128 py::object data = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(self.get())));
131 }, "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
134 py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
136 "An actor is an independent stream of execution in your distributed "
137 "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
140 [](py::args args, py::kwargs kwargs) {
141 xbt_assert(args.size() > 2,
142 "Creating an actor takes at least 3 parameters: name, host, and main function.");
143 return simgrid::s4u::Actor::create(args[0].cast<std::string>(), args[1].cast<Host*>(), [args]() {
144 py::tuple funargs(args.size() - 3);
145 for (size_t i = 3; i < args.size(); i++)
146 funargs[i - 3] = args[i];
148 PyObject* result = PyObject_CallObject(args[2].ptr(), funargs.ptr());
150 throw pybind11::error_already_set();
153 "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`")
154 .def_property("host", &Actor::get_host, &Actor::migrate, "The host on which this actor is located")
155 .def("migrate", &Actor::migrate, "Moves that actor to another host, see :cpp:func:`void simgrid::s4u::Actor::migrate()`",
157 .def("suspend", &Actor::suspend, "Suspend that actor, that is blocked until resume()ed by another actor. See :cpp:func:`void simgrid::s4u::Actor::suspend()`")
158 .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed. See :cpp:func:`void simgrid::s4u::Actor::suspend()`");