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