src/bindings/python/simgrid_python.cpp

   1 /* Copyright (c) 2018-2019. 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 <pybind11/pybind11.h> // Must be first
   7 #include <pybind11/stl.h>
   8
   9 #include "src/kernel/context/Context.hpp"
  10 #include <simgrid/s4u/Actor.hpp>
  11 #include <simgrid/s4u/Engine.hpp>
  12 #include <simgrid/s4u/Host.hpp>
  13 #include <simgrid/s4u/Mailbox.hpp>
  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   // Internal exception used to kill actors and sweep the RAII chimney (free objects living on the stack)
  51   py::object pyStopRequestEx = py::register_exception<simgrid::kernel::context::Context::StopRequest>(m, "ActorKilled");
  52
  53   /* this_actor namespace */
  54   void (*sleep_for_fun)(double) = &simgrid::s4u::this_actor::sleep_for; // pick the right overload
  55   void (*sleep_until_fun)(double) = &simgrid::s4u::this_actor::sleep_until;
  56
  57   py::module m2 = m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace.");
  58   m2.def("info", [](char* s) { XBT_INFO("%s", s); }, "Display a logging message of default priority.");
  59   m2.def("error", [](char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.");
  60   m2.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
  61          "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void "
  62          "simgrid::s4u::this_actor::execute(double, double)`",
  63          py::arg("flops"), py::arg("priority") = 1);
  64   m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrives host on which the current actor is located");
  65   m2.def("migrate", &simgrid::s4u::this_actor::migrate, "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::migrate()`",
  66       py::arg("dest"));
  67   m2.def("sleep_for", sleep_for_fun,
  68       "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`", py::arg("duration"));
  69   m2.def("sleep_until", sleep_until_fun,
  70       "Block the actor sleeping until the specified timestamp, see :cpp:func:`void simgrid::s4u::this_actor::sleep_until`", py::arg("duration"));
  71   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`");
  72   m2.def("yield_", &simgrid::s4u::this_actor::yield,
  73          "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
  74   m2.def("exit", &simgrid::s4u::this_actor::exit, "kill the current actor");
  75   m2.def("kill", [](py::int_ pid) { Actor::kill(pid); }, "Kill an actor by pid");
  76   m2.def("kill_all", &Actor::kill_all, "Kill all actors but the caller.");
  77
  78   m2.def(
  79       "on_exit",
  80       [](py::function fun) { simgrid::s4u::this_actor::on_exit([fun](int ignored, void* data) { fun(); }, nullptr); },
  81       "");
  82
  83   /* Class Engine */
  84   py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
  85       .def(py::init([](std::vector<std::string> args) -> simgrid::s4u::Engine* {
  86         static char noarg[] = {'\0'};
  87         int argc            = args.size();
  88         std::unique_ptr<char* []> argv(new char*[argc + 1]);
  89         for (int i = 0; i != argc; ++i)
  90           argv[i] = args[i].empty() ? noarg : &args[i].front();
  91         argv[argc] = nullptr;
  92         // Currently this can be dangling, we should wrap this somehow.
  93         return new simgrid::s4u::Engine(&argc, argv.get());
  94       }))
  95       .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
  96       .def("get_clock", &Engine::get_clock, "Retrieve the simulation time (in seconds)")
  97       .def("load_platform", &Engine::load_platform,
  98            "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
  99       .def("load_deployment", &Engine::load_deployment,
 100            "Load a deployment file and launch the actors that it contains, see "
 101            ":cpp:func:`simgrid::s4u::Engine::load_deployment()`")
 102       .def("run", &Engine::run, "Run the simulation")
 103       .def("register_actor",
 104            [pyStopRequestEx](Engine*, std::string name, py::object fun_or_class) {
 105              simgrid::simix::register_function(
 106                  name, [pyStopRequestEx, fun_or_class](std::vector<std::string> args) -> simgrid::simix::ActorCode {
 107                    return [pyStopRequestEx, fun_or_class, args]() {
 108                      try {
 109                        /* Convert the std::vector into a py::tuple */
 110                        py::tuple params(args.size() - 1);
 111                        for (size_t i = 1; i < args.size(); i++)
 112                          params[i - 1] = py::cast(args[i]);
 113
 114                        py::object res = fun_or_class(*params);
 115
 116                        /* If I was passed a class, I just built an instance, so I need to call it now */
 117                        if (py::isinstance<py::function>(res))
 118                          res();
 119                      } catch (py::error_already_set& ex) {
 120                        if (ex.matches(pyStopRequestEx)) {
 121                          XBT_VERB("Actor killed");
 122                          /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
 123                        } else {
 124                          throw;
 125                        }
 126                      }
 127                    };
 128                  });
 129            },
 130            "Registers the main function of an actor, see :cpp:func:`simgrid::s4u::Engine::register_function()`");
 131
 132   /* Class Host */
 133   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`")
 134       .def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
 135       .def("current", &Host::current, "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
 136       .def_property_readonly("name", [](Host* self) -> const std::string {
 137           return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 138         }, "The name of this host")
 139       .def_property_readonly("speed", &Host::get_speed,
 140           "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()`");
 141
 142   /* Class Mailbox */
 143   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
 144       .def("by_name", &Mailbox::by_name, "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
 145       .def_property_readonly("name", [](Mailbox* self) -> const std::string {
 146          return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
 147       }, "The name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
 148       .def("put", [](Mailbox self, py::object data, int size) {
 149         data.inc_ref();
 150         self.put(data.ptr(), size);
 151       }, "Blocking data transmission, see :cpp:func:`void simgrid::s4u::Mailbox::put(void*, uint64_t)`")
 152       .def("get", [](Mailbox self) -> py::object {
 153          py::object data = pybind11::reinterpret_steal<py::object>(pybind11::handle(static_cast<PyObject*>(self.get())));
 154          data.dec_ref();
 155          return data;
 156       }, "Blocking data reception, see :cpp:func:`void* simgrid::s4u::Mailbox::get()`");
 157
 158   /* Class Actor */
 159   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
 160                                             "An actor is an independent stream of execution in your distributed "
 161                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
 162
 163       .def("create",
 164            [pyStopRequestEx](py::str name, py::object host, py::object fun, py::args args) {
 165
 166              return simgrid::s4u::Actor::create(name, host.cast<Host*>(), [fun, args, pyStopRequestEx]() {
 167
 168                try {
 169                  fun(*args);
 170                } catch (py::error_already_set& ex) {
 171                  if (ex.matches(pyStopRequestEx)) {
 172                    XBT_VERB("Actor killed");
 173                    /* Stop here that StopRequest exception which was meant to free the RAII stuff on the stack */
 174                  } else {
 175                    throw;
 176                  }
 177                }
 178              });
 179            },
 180            "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`")
 181       .def_property("host", &Actor::get_host, &Actor::migrate, "The host on which this actor is located")
 182       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
 183       .def("daemonize", &Actor::daemonize,
 184            "This actor will be automatically terminated when the last non-daemon actor finishes, see :cpp:func:`void "
 185            "simgrid::s4u::Actor::daemonize()`")
 186       .def("join", py::overload_cast<double>(&Actor::join),
 187            "Wait for the actor to finish, see :cpp:func:`void simgrid::s4u::Actor::join(double)`", py::arg("timeout"))
 188       .def("kill", [](py::int_ pid) { Actor::kill(pid); }, "Kill an actor by pid")
 189       .def("kill", [](ActorPtr act) { act->kill(); }, "Kill that actor")
 190       .def("kill_all", &Actor::kill_all, "Kill all actors but the caller.")
 191       .def("migrate", &Actor::migrate,
 192            "Moves that actor to another host, see :cpp:func:`void simgrid::s4u::Actor::migrate()`", py::arg("dest"))
 193       .def("self", &Actor::self, "Retrieves the current actor, see :cpp:func:`void simgrid::s4u::Actor::self()`")
 194       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
 195       .def("suspend", &Actor::suspend, "Suspend that actor, that is blocked until resume()ed by another actor.")
 196       .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed.");
 197 }