src/bindings/python/simgrid_python.cpp

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