Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
allow python actors to be killed
[simgrid.git] / src / bindings / python / simgrid_python.cpp
1 /* Copyright (c) 2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "src/kernel/context/Context.hpp"
7 #include <simgrid/s4u/Actor.hpp>
8 #include <simgrid/s4u/Engine.hpp>
9 #include <simgrid/s4u/Host.hpp>
10 #include <simgrid/s4u/Mailbox.hpp>
11
12 #include <pybind11/pybind11.h>
13 #include <pybind11/stl.h>
14
15 #include <memory>
16 #include <string>
17 #include <vector>
18
19 namespace py = pybind11;
20 using simgrid::s4u::Actor;
21 using simgrid::s4u::ActorPtr;
22 using simgrid::s4u::Engine;
23 using simgrid::s4u::Host;
24 using simgrid::s4u::Mailbox;
25
26 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
27
28 PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>);
29
30 namespace {
31
32 static std::string get_simgrid_version()
33 {
34   int major, minor, patch;
35   sg_version_get(&major, &minor, &patch);
36   return simgrid::xbt::string_printf("%i.%i.%i", major, minor, patch);
37 }
38
39 static std::string simgrid_version = get_simgrid_version();
40
41 } // namespace
42
43 PYBIND11_MODULE(simgrid, m)
44 {
45
46   m.doc() = "SimGrid userspace API";
47
48   m.attr("simgrid_version") = simgrid_version;
49
50   /* this_actor namespace */
51   void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload
52   void (*sleep_until_fun)(double) = &simgrid::s4u::this_actor::sleep_until;
53
54   py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.");
55   m2.def("info", [](char* s) { XBT_INFO("%s", s); }, "Display a logging message of default priority.");
56   m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
57          "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
58          "simgrid::s4u::this_actor::execute(double, double)`",
59          py::arg("flops"), py::arg("priority") = 1);
60   m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrives host on which the current actor is located");
61   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       py::arg("dest"));
63   m2.def("sleep_for", sleep_for_fun,
64       "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`", py::arg("duration"));
65   m2.def("sleep_until", sleep_until_fun,
66       "Block the actor sleeping until the specified timestamp, see :cpp:func:`void simgrid::s4u::this_actor::sleep_until`", py::arg("duration"));
67   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`");
68   m2.def("yield_", &simgrid::s4u::this_actor::yield,
69          "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
70
71   /* Class Engine */
72   py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
73       .def(py::init([](std::vector<std::string> args) -> simgrid::s4u::Engine* {
74         static char noarg[] = {'\0'};
75         int argc            = args.size();
76         std::unique_ptr<char* []> argv(new char*[argc + 1]);
77         for (int i = 0; i != argc; ++i)
78           argv[i] = args[i].empty() ? noarg : &args[i].front();
79         argv[argc] = nullptr;
80         // Currently this can be dangling, we should wrap this somehow.
81         return new simgrid::s4u::Engine(&argc, argv.get());
82       }))
83       .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
84       .def("get_clock", &Engine::get_clock, "Retrieve the simulation time")
85       .def("load_platform", &Engine::load_platform,
86           "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
87       .def("load_deployment", &Engine::load_deployment,
88           "Load a deployment file and launch the actors that it contains, see :cpp:func:`simgrid::s4u::Engine::load_deployment()`")
89       .def("run", &Engine::run, "Run the simulation")
90       .def("register_actor", [](Engine*, std::string name, py::object obj) {
91         simgrid::simix::register_function(name,
92             [obj](std::vector<std::string> args) -> simgrid::simix::ActorCode {
93           return [obj, args]() {
94             /* Convert the std::vector into a py::tuple */
95             py::tuple params(args.size()-1);
96             for (size_t i=1; i<args.size(); i++)
97               params[i-1] = py::cast(args[i]);
98
99             PyObject *result = PyObject_CallObject(obj.ptr(), params.ptr());
100             if (!result)
101                 throw pybind11::error_already_set();
102
103             /* If I was passed a class, I just built an instance, so I need to call it now */
104             if (PyCallable_Check(result)) {
105               py::object obj2 = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(result)));
106               obj2();
107             }
108           };
109         });
110       }, "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`")
111       ;
112
113   /* Class Host */
114   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
115       .def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
116       .def("current", &Host::current, "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
117       .def_property_readonly("name", [](Host* self) -> const std::string {
118           return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
119         }, "The name of this host")
120       .def_property_readonly("speed", &Host::get_speed,
121           "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()`");
122
123   /* Class Mailbox */
124   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
125       .def("by_name", &Mailbox::by_name, "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
126       .def_property_readonly("name", [](Mailbox* self) -> const std::string {
127          return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
128       }, "The name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
129       .def("put", [](Mailbox self, py::object data, int size) {
130         data.inc_ref();
131         self.put(data.ptr(), size);
132       }, "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
133       .def("get", [](Mailbox self) -> py::object {
134          py::object data = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(self.get())));
135          data.dec_ref();
136          return data;
137       }, "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
138
139   /* Class Actor */
140   py::object pyStopRequestEx = py::register_exception<simgrid::kernel::context::Context::StopRequest>(m, "ActorKilled");
141   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
142                                             "An actor is an independent stream of execution in your distributed "
143                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
144
145       .def("create",
146            [pyStopRequestEx](py::str name, py::object host, py::object fun, py::args args) {
147
148              return simgrid::s4u::Actor::create(name, host.cast<Host*>(), [fun, args, pyStopRequestEx]() {
149
150                try {
151                  fun(*args);
152                } catch (py::error_already_set& ex) {
153                  if (ex.matches(pyStopRequestEx)) {
154                    /* The actor was killed.
155                     * Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
156                  } else {
157                    throw;
158                  }
159                }
160              });
161            },
162            "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`")
163       .def_property("host", &Actor::get_host, &Actor::migrate, "The host on which this actor is located")
164       .def("daemonize", &Actor::daemonize,
165            "This actor will be automatically terminated when the last non-daemon actor finishes, see :cpp:func:`void "
166            "simgrid::s4u::Actor::daemonize()`")
167       .def("join", py::overload_cast<double>(&Actor::join),
168            "Wait for the actor to finish, see :cpp:func:`void simgrid::s4u::Actor::join(double)`", py::arg("timeout"))
169       .def("migrate", &Actor::migrate,
170            "Moves that actor to another host, see :cpp:func:`void simgrid::s4u::Actor::migrate()`", py::arg("dest"))
171       .def("self", &Actor::self, "Retrieves the current actor, see :cpp:func:`void simgrid::s4u::Actor::self()`")
172       .def("suspend", &Actor::suspend,
173            "Suspend that actor, that is blocked until resume()ed by another actor. See :cpp:func:`void "
174            "simgrid::s4u::Actor::suspend()`")
175       .def("resume", &Actor::resume,
176            "Resume that actor, that was previously suspend()ed. See :cpp:func:`void simgrid::s4u::Actor::suspend()`");
177 }