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