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