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